openGauss-JDBC 调试方法

1 内容及目的

openGauss-jdbc调试方法，便于快速搭建调试环境

2 配置环境过程

操作系统：openEuler22.03 X86

前提要求：

有可用的openGauss数据库

3 实践过程

3.1 安装依赖

软件及环境依赖要求如下：

软件及环境要求	推荐版本
maven	3.6.1
java	1.8
Git Bash (Windows)	无推荐版本

bash
sudo dnf update
sudo dnf install -y java-1.8.0-openjdk-devel
# 安装完成后，可通过以下命令验证是否安装成功：
java -version

安装 Maven 3.6.1

访问Maven 官方下载页面
在页面中找到 “Maven 3 archives”，点击进入，找到 3.6.1 版本并下载对应的压缩包，推荐下载.tar.gz格式的文件。
在 openEuler 系统中创建一个文件夹用于存放 Maven 安装包，例如：
```
bash
mkdir ~/maven
cd ~/maven
tar -zxvf apache-maven-3.6.1-bin.tar.gz
```
配置环境变量，编辑~/.bachrc文件：
```
bash
nano ~/.bachrc
```
在文件末尾添加以下内容：
```
bash
export MAVEN_HOME=/a-dev/maven/apache-maven-3.6.1
export PATH=$MAVEN_HOME/bin:$PATH
```
保存并退出编辑，然后执行source ~/.bashrc使配置生效。
验证安装，执行命令：
```
bash
mvn -v
```

若显示 Maven 版本信息，则表示安装成功。

3.2 安装vscode插件

在vscode插件市场里安装以下插件，注意如果是调试代码在服务器上，则必须在服务器上的vscode安装该扩展（图中LOCAL-INSTALLED中的是本地vscode安装的插件，SSH：IP-INSTALLED中显示的是服务器中安装的插件，黄色按钮表示可以将插件安装到服务器上）

Extension Pack for Java
Debugger for Java
Maven for Java
Project Manager for Java
Test Runner for Java

3.3 编译jdbc

克隆代码并编译

bash
mkdir ~/proj
cd ~/proj
git clone https://gitcode.com/opengauss/openGauss-connector-jdbc.git
cd openGauss-connnector-jdbc
sh build.sh

编译成功之后会显示

编译后的jar包在output目录下

编写测试代码

新建测试文件夹

bash
mkdir -p pgjdbc-client/src/main/java/com/example/
cd pgjdbc-client/src/main/java/com/example/

新建测试文件 PostgresTest.java

java
package com.example;

import java.sql.*;

public class PostgresTest {
    public static void main(String[] args) {
        // 数据库连接信息
        String url = "jdbc:postgresql://localhost:33000/tpccdb";
        String username = "tpcc";
        String password = "tpcc@123";

        // SQL查询语句
        String sql = "SELECT * FROM users";

        try (Connection conn = DriverManager.getConnection(url, username, password);
             Statement stmt = conn.createStatement();
             ResultSet rs = stmt.executeQuery(sql)) {

            System.out.println("数据库连接成功！");
            System.out.println("服务器版本: " + conn.getMetaData().getDatabaseProductVersion());

            System.out.println("\n查询结果:");
            while (rs.next()) {
                int id = rs.getInt("id");
                String name = rs.getString("name");
                double salary = rs.getDouble("age");
                System.out.printf("ID: %d, 姓名: %s, 年龄: %.2f%n", id, name, salary);
            }

        } catch (SQLException e) {
            System.err.println("数据库操作失败: " + e.getMessage());
            e.printStackTrace();
        }
    }
}

配置Maven依赖

java
cd ~/proj/opengauss-connector-jdbc/pgjdbc-client/

在pgjdbc-client目录下创建pom.xml文件，写入下面的配置信息

xml
<project xmlns="http://maven.apache.org/POM/4.0.0"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
                             http://maven.apache.org/maven-v4_0_0.xsd">

    <modelVersion>4.0.0</modelVersion>
    <parent>
        <groupId>com.huawei</groupId>
        <groupId>pgjdbc-aggregate</artifactId>
        <version>42.2.5</version>
    </parent>
    <artifactId>pgjdbc-client</artifactId>

    <dependencies>
        <!-- 本地模块依赖 openGauss JDBC -->
        <dependency>
            <groupId>org.opengauss</groupId>
            <artifactId>opengauss-jdbc</artifactId>
            <version>7.0.0-RC2</version>
        </dependency>
    </dependencies>
    
</project>

其中parent字段的groupId、groupId、version内容要与openGauss-connector-jdbc路径下的pom.xml里的内容完全对应

dependency字段的groupId、groupId、version内容要与openGauss-connector-jdbc/pgjdbc路径下的pom.xml里的内容完全对应。

修改openGauss-connector-jdbc/pom.xml

xml
  <modules>
    <module>pgjdbc</module>
    <!-- 新增下面这一行-->
    <module>pgjdbc-client</module> 
  </modules>

3.4 运行和调试代码

配置好上面的Maven依赖后，使用vscode打开~/proj/openGauss-connector-jdbc/文件夹，等待初始化一段时间。

正确加载完成后侧边栏最上面会显示有三个Java projects，三个maven项目

此时打开~/proj/opengauss-connector-jdbc/pgjdbc-client/PostgresTest.java文件，main函数上面就会显示Run|Debug两个按钮

点击Run就会直接运行main函数

设置好断点，点击Debug即可进行调试（可以直接在pgjdbc下的驱动源码打断点）

目录