Java获取数据库表结构的工具
前言
Github:https://github.com/HealerJean
1、工具类
package com.healerjean.proj.util.jdbc;
import lombok.extern.slf4j.Slf4j;
import org.junit.Test;
import java.sql.*;
import java.util.ArrayList;
import java.util.List;
/**
* @author HealerJean
* @ClassName JdbcUtils
* @date 2020/2/25 17:05.
* @Description
*/
@Slf4j
public class JdbcUtils {
/**
* 获取字段相关类:
* 使用完记得关闭连接
*/
public static ResultSetMetaData getResultSetMetaData(String tableName) {
PreparedStatement preparedStatement = null;
ResultSetMetaData resultSetMetaData = null;
Connection connection = getConnection();
try {
preparedStatement = connection.prepareStatement("select * from " + tableName + " where 1=2");
resultSetMetaData = preparedStatement.executeQuery().getMetaData();
} catch (Exception e) {
log.error("数据库连接异常", e);
} finally {
closePreparedStatement(preparedStatement);
closeConnection(connection);
}
return resultSetMetaData;
}
/**
* 获取当前数据库下的所有表名称
*/
public static List<String> getAllTableName() {
List<String> tables = new ArrayList();
Connection connection = getConnection();
Statement statement = null;
ResultSet resultSet = null;
try {
statement = connection.createStatement();
resultSet = statement.executeQuery("SHOW TABLES ");
while (resultSet.next()) {
String tableName = resultSet.getString(1);
tables.add(tableName);
}
} catch (SQLException e) {
log.error("数据库连接异常", e);
} finally {
closeResultSet(resultSet);
closeStatement(statement);
closeConnection(connection);
}
return tables;
}
/**
* 获得某表的建表语句
*/
public static String getCreateTableDDL(String tableName) {
Connection connection = getConnection();
Statement statement = null;
ResultSet resultSet = null;
String createDDLSql = null;
try {
statement = connection.createStatement();
resultSet = statement.executeQuery("SHOW CREATE TABLE " + tableName);
if (resultSet != null && resultSet.next()) {
createDDLSql = resultSet.getString(2);
}
} catch (SQLException e) {
log.error("数据库连接异常", e);
} finally {
closeResultSet(resultSet);
closeStatement(statement);
closeConnection(connection);
}
return createDDLSql;
}
/**
* 获得某表的注释
*/
public static String getTableCommnet(String tableName) {
String creatDDLSql = getCreateTableDDL(tableName);
String comment = null;
int index = creatDDLSql.indexOf("COMMENT='");
if (index < 0) {
return "";
}
comment = creatDDLSql.substring(index + 9);
comment = comment.substring(0, comment.length() - 1);
return comment;
}
/**
* 获取表中字段的所有注释
*/
public static List<String> getColumnComments(String tableName) {
//与数据库的连接
Connection connection = getConnection();
PreparedStatement preparedStatement = null;
String tableSql = "select * from " + tableName;
//列名注释集合
List<String> columnComments = new ArrayList<>();
ResultSet resultSet = null;
try {
preparedStatement = connection.prepareStatement(tableSql);
resultSet = preparedStatement.executeQuery("show full columns from " + tableName);
while (resultSet.next()) {
columnComments.add(resultSet.getString("Comment"));
}
} catch (SQLException e) {
log.error("数据库连接异常", e);
} finally {
closeResultSet(resultSet);
closeStatement(preparedStatement);
closeConnection(connection);
}
return columnComments;
}
/**
* 获取数据连接
*/
public static Connection getConnection() {
Connection connection = null;
try {
Class.forName("com.mysql.jdbc.Driver");
connection = DriverManager.getConnection("jdbc:mysql://127.0.0.1:3306/consumer_finance?useUnicode=true&characterEncoding=UTF-8&autoReconnect=true", "root", "123456");
} catch (Exception e) {
log.error("get connection failure", e);
}
return connection;
}
/**
* 关闭数据库连接
*/
public static void closeConnection(Connection conn) {
if (conn != null) {
try {
conn.close();
} catch (SQLException e) {
log.error("close connection failure", e);
}
}
}
public static void closePreparedStatement(PreparedStatement preparedStatement) {
if (preparedStatement != null) {
try {
preparedStatement.close();
} catch (SQLException e) {
log.error("close preparedStatement failure ", e);
}
}
}
public static void closeResultSet(ResultSet resultSet) {
if (resultSet != null) {
try {
resultSet.close();
} catch (SQLException e) {
log.error("close resultSet failure ", e);
}
}
}
public static void closeStatement(Statement statement) {
if (statement != null) {
try {
statement.close();
} catch (SQLException e) {
log.error("close statement failure ", e);
}
}
}
}
1.1、测试
@Test
public void test() throws Exception {
System.out.println("获取所有数据库的表名" + getAllTableName());
String tableName = "consume_user_extend_info";
System.out.println("获取建表语句:" + getCreateTableDDL(tableName));
System.out.println("获取表的备注:" + getTableCommnet(tableName));
System.out.println("打印字段信息:");
List<String> columnComments = getColumnComments(tableName);
ResultSetMetaData resultSetMetaData = getResultSetMetaData(tableName);
int columnCount = resultSetMetaData.getColumnCount();
System.out.println(tableName + "表中字段个数为:" + columnCount);
for (int i = 1; i <= columnCount; i++) {
System.out.print("java类型:" + resultSetMetaData.getColumnClassName(i));
System.out.print(" 数据库类型:" + resultSetMetaData.getColumnTypeName(i).toLowerCase());
System.out.print(" 字段名称:" + resultSetMetaData.getColumnName(i));
System.out.print(" 字段长度:" + resultSetMetaData.getColumnDisplaySize(i));
System.out.print(" notNull:" + (resultSetMetaData.isNullable(i) == 1 ? false : true));
System.out.println(" 注释为:" + columnComments.get(i - 1));
}
}
}
1.2、测试结果打印
获取所有数据库的表名[consume_contract, consume_contract_fdd_log, consume_loan_order, consume_loan_record, consume_loan_repay_plan, consume_risk_limit, consume_sys_dictionary_data, consume_sys_dictionary_type, consume_sys_district, consume_sys_file, consume_sys_operation_log, consume_sys_sms_log, consume_user_bank_card, consume_user_extend_info, consume_user_info]
获取建表语句:CREATE TABLE `consume_user_extend_info` (
`id` bigint(20) unsigned NOT NULL AUTO_INCREMENT COMMENT '主键',
`ref_user_id` bigint(20) unsigned NOT NULL COMMENT '关联用户id',
`nation` varchar(32) COLLATE utf8_bin NOT NULL DEFAULT '' COMMENT '民族',
`address` varchar(128) COLLATE utf8_bin NOT NULL DEFAULT '' COMMENT '地址',
`birth` datetime DEFAULT NULL COMMENT '出生日期',
`authority` varchar(128) COLLATE utf8_bin NOT NULL DEFAULT '' COMMENT '证件签发机关',
`valid_date` datetime DEFAULT NULL COMMENT '证件有效期',
`ref_face_file_ids` varchar(128) COLLATE utf8_bin NOT NULL DEFAULT '' COMMENT '身份证正反面信息,数组表示,前面是正面,后面是反面',
`ref_video_face_file_id` varchar(32) COLLATE utf8_bin NOT NULL DEFAULT '' COMMENT '人脸识别视频最佳面部截图文件id',
`ref_video_file_id` varchar(32) COLLATE utf8_bin NOT NULL DEFAULT '' COMMENT '人脸识别视频文件id',
`company_name` varchar(128) COLLATE utf8_bin NOT NULL DEFAULT '' COMMENT '单位名称',
`position` varchar(32) COLLATE utf8_bin NOT NULL DEFAULT '' COMMENT '职位名称:字典表',
`monthly_income` decimal(20,0) NOT NULL DEFAULT '0' COMMENT '月收入',
`company_province` varchar(8) COLLATE utf8_bin NOT NULL DEFAULT '' COMMENT '单位地址-省',
`company_city` varchar(8) COLLATE utf8_bin NOT NULL DEFAULT '' COMMENT '单位地址-市',
`company_town` varchar(8) COLLATE utf8_bin NOT NULL DEFAULT '' COMMENT '单位地址-区/县',
`company_address` varchar(128) COLLATE utf8_bin NOT NULL DEFAULT '' COMMENT '单位详细地址',
`current_reside_province` varchar(8) COLLATE utf8_bin NOT NULL DEFAULT '' COMMENT '现居住-省',
`current_reside_city` varchar(8) COLLATE utf8_bin NOT NULL DEFAULT '' COMMENT '现居住-市',
`current_reside_town` varchar(8) COLLATE utf8_bin NOT NULL DEFAULT '' COMMENT '现居住-区/县',
`current_reside_address` varchar(128) COLLATE utf8_bin NOT NULL DEFAULT '' COMMENT '现居住详细地址',
`parent_name` varchar(64) COLLATE utf8_bin NOT NULL DEFAULT '' COMMENT '父母姓名(父亲或母亲)',
`parent_telephone` varchar(20) COLLATE utf8_bin NOT NULL DEFAULT '' COMMENT '父母手机号',
`friend_name` varchar(64) COLLATE utf8_bin NOT NULL DEFAULT '' COMMENT '同学姓名',
`friend_telephone` varchar(20) COLLATE utf8_bin NOT NULL DEFAULT '' COMMENT '同学手机号',
`qq` varchar(20) COLLATE utf8_bin NOT NULL DEFAULT '' COMMENT '本人qq',
`email` varchar(128) COLLATE utf8_bin NOT NULL DEFAULT '' COMMENT '本人邮箱',
`create_time` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP COMMENT '创建时间',
`update_user` bigint(20) unsigned NOT NULL DEFAULT '0' COMMENT '更新人',
`update_name` varchar(64) COLLATE utf8_bin NOT NULL DEFAULT '' COMMENT '更新人名称',
`update_time` datetime NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '更新时间',
PRIMARY KEY (`id`) USING BTREE,
UNIQUE KEY `uk_user_id` (`ref_user_id`) USING BTREE COMMENT '关联用户id'
) ENGINE=InnoDB DEFAULT CHARSET=utf8 COLLATE=utf8_bin COMMENT='用户管理-用户信息扩展表'
获取表的备注:用户管理-用户信息扩展表
打印字段信息:
consume_user_extend_info表中字段个数为:31
java类型:java.math.BigInteger 数据库类型:bigint unsigned 字段名称:id 字段长度:20 notNull:true 注释为:主键
java类型:java.math.BigInteger 数据库类型:bigint unsigned 字段名称:ref_user_id 字段长度:20 notNull:true 注释为:关联用户id
java类型:java.lang.String 数据库类型:varchar 字段名称:nation 字段长度:32 notNull:true 注释为:民族
java类型:java.lang.String 数据库类型:varchar 字段名称:address 字段长度:128 notNull:true 注释为:地址
java类型:java.sql.Timestamp 数据库类型:datetime 字段名称:birth 字段长度:19 notNull:false 注释为:出生日期
java类型:java.lang.String 数据库类型:varchar 字段名称:authority 字段长度:128 notNull:true 注释为:证件签发机关
java类型:java.sql.Timestamp 数据库类型:datetime 字段名称:valid_date 字段长度:19 notNull:false 注释为:证件有效期
java类型:java.lang.String 数据库类型:varchar 字段名称:ref_face_file_ids 字段长度:128 notNull:true 注释为:身份证正反面信息,数组表示,前面是正面,后面是反面
java类型:java.lang.String 数据库类型:varchar 字段名称:ref_video_face_file_id 字段长度:32 notNull:true 注释为:人脸识别视频最佳面部截图文件id
java类型:java.lang.String 数据库类型:varchar 字段名称:ref_video_file_id 字段长度:32 notNull:true 注释为:人脸识别视频文件id
java类型:java.lang.String 数据库类型:varchar 字段名称:company_name 字段长度:128 notNull:true 注释为:单位名称
java类型:java.lang.String 数据库类型:varchar 字段名称:position 字段长度:32 notNull:true 注释为:职位名称:字典表
java类型:java.math.BigDecimal 数据库类型:decimal 字段名称:monthly_income 字段长度:21 notNull:true 注释为:月收入
java类型:java.lang.String 数据库类型:varchar 字段名称:company_province 字段长度:8 notNull:true 注释为:单位地址-省
java类型:java.lang.String 数据库类型:varchar 字段名称:company_city 字段长度:8 notNull:true 注释为:单位地址-市
java类型:java.lang.String 数据库类型:varchar 字段名称:company_town 字段长度:8 notNull:true 注释为:单位地址-区/县
java类型:java.lang.String 数据库类型:varchar 字段名称:company_address 字段长度:128 notNull:true 注释为:单位详细地址
java类型:java.lang.String 数据库类型:varchar 字段名称:current_reside_province 字段长度:8 notNull:true 注释为:现居住-省
java类型:java.lang.String 数据库类型:varchar 字段名称:current_reside_city 字段长度:8 notNull:true 注释为:现居住-市
java类型:java.lang.String 数据库类型:varchar 字段名称:current_reside_town 字段长度:8 notNull:true 注释为:现居住-区/县
java类型:java.lang.String 数据库类型:varchar 字段名称:current_reside_address 字段长度:128 notNull:true 注释为:现居住详细地址
java类型:java.lang.String 数据库类型:varchar 字段名称:parent_name 字段长度:64 notNull:true 注释为:父母姓名(父亲或母亲)
java类型:java.lang.String 数据库类型:varchar 字段名称:parent_telephone 字段长度:20 notNull:true 注释为:父母手机号
java类型:java.lang.String 数据库类型:varchar 字段名称:friend_name 字段长度:64 notNull:true 注释为:同学姓名
java类型:java.lang.String 数据库类型:varchar 字段名称:friend_telephone 字段长度:20 notNull:true 注释为:同学手机号
java类型:java.lang.String 数据库类型:varchar 字段名称:qq 字段长度:20 notNull:true 注释为:本人qq
java类型:java.lang.String 数据库类型:varchar 字段名称:email 字段长度:128 notNull:true 注释为:本人邮箱
java类型:java.sql.Timestamp 数据库类型:datetime 字段名称:create_time 字段长度:19 notNull:true 注释为:创建时间
java类型:java.math.BigInteger 数据库类型:bigint unsigned 字段名称:update_user 字段长度:20 notNull:true 注释为:更新人
java类型:java.lang.String 数据库类型:varchar 字段名称:update_name 字段长度:64 notNull:true 注释为:更新人名称
java类型:java.sql.Timestamp 数据库类型:datetime 字段名称:update_time 字段长度:19 notNull:true 注释为:更新时间
Process finished with exit code 0
1.3、总结
1、关于decimal 的长度获取不到 (20,6)
2、 无法获取字段的额默认值