JDBC获取元数据

发表于 2020-11-28 更新于 2025-08-11 分类于 JDBC Waline：阅读次数：本文字数： 6.7k 阅读时长 ≈ 6 分钟

JDBC 元数据获取详解：探索数据库与结果集的底层信息

在 JDBC 编程中，除了执行 SQL 操作获取业务数据外，有时还需要获取数据库本身的信息（如数据库版本、支持的功能）或结果集的结构（如列名、数据类型）。这些描述数据的数据称为元数据（Metadata）。JDBC 提供了 DatabaseMetaData 和 ResultSetMetaData 两个核心接口，分别用于获取数据库元数据和结果集元数据。本文将详细讲解这两种元数据的获取与应用。

数据库元数据（DatabaseMetaData）

DatabaseMetaData 接口用于描述数据库的整体信息，通过 Connection.getMetaData() 方法获取，可获取数据库产品名称、版本、支持的 SQL 特性、表结构等底层信息。

核心方法与示例

（1）获取数据库基本信息

import java.sql.Connection;
import java.sql.DatabaseMetaData;
import java.sql.SQLException;

public class DatabaseMetaDataDemo {
    public static void main(String[] args) {
        try (Connection conn = JDBCUtil.getConnection()) { // 自定义连接工具类
            // 获取数据库元数据对象
            DatabaseMetaData metaData = conn.getMetaData();

            // 1. 数据库产品信息
            String productName = metaData.getDatabaseProductName(); // 如 "MySQL"
            String productVersion = metaData.getDatabaseProductVersion(); // 如 "8.0.30"
            int majorVersion = metaData.getDatabaseMajorVersion(); // 主版本号，如 8
            int minorVersion = metaData.getDatabaseMinorVersion(); // 次版本号，如 0

            // 2. JDBC 驱动信息
            String driverName = metaData.getDriverName(); // 如 "MySQL Connector/J"
            String driverVersion = metaData.getDriverVersion(); // 如 "8.0.30"
            int driverMajor = metaData.getDriverMajorVersion(); // 驱动主版本
            int driverMinor = metaData.getDriverMinorVersion(); // 驱动次版本

            // 3. 连接信息
            String userName = metaData.getUserName(); // 连接数据库的用户名
            String url = metaData.getURL(); // 数据库连接 URL

            // 打印信息
            System.out.println("数据库产品：" + productName + " " + productVersion);
            System.out.println("数据库版本：" + majorVersion + "." + minorVersion);
            System.out.println("JDBC 驱动：" + driverName + " " + driverVersion);
            System.out.println("连接用户：" + userName + "，URL：" + url);

        } catch (SQLException e) {
            e.printStackTrace();
        }
    }
}

输出示例（MySQL）：

数据库产品：MySQL 8.0.30
数据库版本：8.0
JDBC 驱动：MySQL Connector/J 8.0.30
连接用户：root@localhost，URL：jdbc:mysql://localhost:3306/test

（2）获取数据库中的表和 schema

DatabaseMetaData 提供了获取数据库中表、视图、列等结构信息的方法，返回 ResultSet 结果集：

/**
 * 获取数据库中所有表的信息
 * @param catalog 数据库名（MySQL 中对应 database）
 * @param schemaPattern 模式名（MySQL 中通常为 null）
 * @param tableNamePattern 表名匹配（如 "user%" 匹配以 user 开头的表）
 * @param types 表类型（如 "TABLE"、"VIEW"）
 */
public static void getTables(String catalog, String schemaPattern, 
                            String tableNamePattern, String[] types) {
    try (Connection conn = JDBCUtil.getConnection()) {
        DatabaseMetaData metaData = conn.getMetaData();
        // 获取表信息（返回 ResultSet，包含表名、类型、备注等）
        try (ResultSet rs = metaData.getTables(catalog, schemaPattern, tableNamePattern, types)) {
            System.out.println("数据库中的表：");
            while (rs.next()) {
                String tableName = rs.getString("TABLE_NAME"); // 表名
                String tableType = rs.getString("TABLE_TYPE"); // 类型（TABLE/VIEW）
                String remarks = rs.getString("REMARKS"); // 表备注
                System.out.printf("表名：%s，类型：%s，备注：%s%n", tableName, tableType, remarks);
            }
        }
    } catch (SQLException e) {
        e.printStackTrace();
    }
}

// 调用示例：获取 test 数据库中所有表
getTables("test", null, "%", new String[]{"TABLE"});

关键字段（ResultSet 中）：

TABLE_NAME：表名
TABLE_TYPE：表类型（"TABLE" 表示普通表，"VIEW" 表示视图）
REMARKS：表的注释信息

（3）获取表的列信息

通过 getColumns() 方法可获取指定表的列信息（列名、数据类型等）：

/**
 * 获取指定表的列信息
 */
public static void getTableColumns(String catalog, String schemaPattern, String tableName) {
    try (Connection conn = JDBCUtil.getConnection()) {
        DatabaseMetaData metaData = conn.getMetaData();
        // 获取列信息
        try (ResultSet rs = metaData.getColumns(catalog, schemaPattern, tableName, "%")) {
            System.out.println("\n表 " + tableName + " 的列信息：");
            while (rs.next()) {
                String columnName = rs.getString("COLUMN_NAME"); // 列名
                String typeName = rs.getString("TYPE_NAME"); // 数据库类型名（如 INT、VARCHAR）
                int dataType = rs.getInt("DATA_TYPE"); // JDBC 类型码（如 Types.INTEGER）
                int columnSize = rs.getInt("COLUMN_SIZE"); // 列长度（如 VARCHAR(50) 为 50）
                String isNullable = rs.getString("IS_NULLABLE"); // 是否允许为 null（YES/NO）

                System.out.printf(
                    "列名：%s，类型：%s（JDBC 码：%d），长度：%d，允许 null：%s%n",
                    columnName, typeName, dataType, columnSize, isNullable
                );
            }
        }
    } catch (SQLException e) {
        e.printStackTrace();
    }
}

// 调用示例：获取 test 数据库中 user 表的列信息
getTableColumns("test", null, "user");

输出示例：

表 user 的列信息：
列名：id，类型：INT（JDBC 码：4），长度：11，允许 null：NO
列名：name，类型：VARCHAR（JDBC 码：12），长度：50，允许 null：NO

结果集元数据（ResultSetMetaData）

ResultSetMetaData 用于描述 ResultSet 结果集的结构信息，如列的数量、列名、数据类型等，通过 ResultSet.getMetaData() 或 PreparedStatement.getMetaData() 方法获取。

核心方法与示例

（1）获取结果集的列信息

import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.ResultSet;
import java.sql.ResultSetMetaData;
import java.sql.SQLException;

public class ResultSetMetaDataDemo {
    public static void main(String[] args) {
        String sql = "SELECT id, name FROM user WHERE id < 10";
        try (Connection conn = JDBCUtil.getConnection();
             PreparedStatement pstmt = conn.prepareStatement(sql);
             ResultSet rs = pstmt.executeQuery()) {

            // 获取结果集元数据
            ResultSetMetaData metaData = rs.getMetaData();
            int columnCount = metaData.getColumnCount(); // 列的数量

            System.out.println("结果集列数：" + columnCount);
            System.out.println("列信息：");
            // 遍历列（索引从 1 开始）
            for (int i = 1; i <= columnCount; i++) {
                String columnName = metaData.getColumnName(i); // 数据库列名
                String columnLabel = metaData.getColumnLabel(i); // 列的别名（无别名则同列名）
                String typeName = metaData.getColumnTypeName(i); // 数据库类型名
                int jdbcType = metaData.getColumnType(i); // JDBC 类型码（如 Types.INTEGER）
                int columnDisplaySize = metaData.getColumnDisplaySize(i); // 显示长度

                System.out.printf(
                    "列索引：%d，列名：%s，别名：%s，类型：%s（JDBC 码：%d），长度：%d%n",
                    i, columnName, columnLabel, typeName, jdbcType, columnDisplaySize
                );
            }

        } catch (SQLException e) {
            e.printStackTrace();
        }
    }
}

输出示例：

结果集列数：2
列信息：
列索引：1，列名：id，别名：id，类型：INT（JDBC 码：4），长度：11
列索引：2，列名：name，别名：name，类型：VARCHAR（JDBC 码：12），长度：50

（2）处理带别名的列

当 SQL 中为列指定别名时，getColumnLabel() 会返回别名，而 getColumnName() 返回原始列名：

// SQL 带别名
String sql = "SELECT id AS userId, name AS userName FROM user";
try (Connection conn = JDBCUtil.getConnection();
     PreparedStatement pstmt = conn.prepareStatement(sql);
     ResultSet rs = pstmt.executeQuery()) {

    ResultSetMetaData metaData = rs.getMetaData();
    System.out.println("别名列信息：");
    System.out.println("列1 别名：" + metaData.getColumnLabel(1)); // userId
    System.out.println("列1 原名：" + metaData.getColumnName(1)); // id
    System.out.println("列2 别名：" + metaData.getColumnLabel(2)); // userName
    System.out.println("列2 原名：" + metaData.getColumnName(2)); // name
} catch (SQLException e) {
    e.printStackTrace();
}

输出：

别名列信息：
列1 别名：userId
列1 原名：id
列2 别名：userName
列2 原名：name

最佳实践：处理结果集时，优先使用 getColumnLabel() 获取列标识（支持别名），而非 getColumnName()。

元数据的应用场景

通用数据库工具：如数据库客户端（Navicat）、ORM 框架（MyBatis），通过元数据自动生成表结构、实体类。
动态 SQL 执行：在不确定表结构的情况下，动态解析结果集列信息，适配不同表的查询。
数据库迁移工具：通过元数据读取源数据库表结构，自动在目标数据库创建相同结构的表。
数据校验：验证查询结果的列类型是否符合预期（如确保金额列是数值类型）。

注意事项

性能开销：获取元数据可能涉及数据库系统表的查询，存在一定性能开销，避免频繁调用。
数据库差异：不同数据库的元数据返回结果可能存在差异（如类型名称：MySQL 用 INT，Oracle 用 NUMBER）。
索引从 1 开始：元数据中列的索引均从 1 开始（与 JDBC 一致），而非 0。
权限限制：获取元数据可能需要数据库的查询权限（如查询系统表的权限）