JDBC元数据驱动的XML自动生成工具

简介这是一款面向Java开发人员与数据库管理员的XML自动化生成工具解决手动编写XML易出错、效率低的问题特别适用于需频繁将数据库查询结果导出为结构化XML配置文件或数据交换文档的场景。资源包共4个文件含1个可执行程序JdbcGenerator.exe用于驱动整个生成流程1个INI配置文件init.ini管理基础参数1个XML模板文件global.datasource.xml定义输出结构以及1个properties文件jdbc.properties存储数据库连接信息整体仅144KB轻量易部署。已有2354人学习下载说明其在中小型项目快速集成与教学演示中具备较高实用性。用户可直接运行exe程序通过JDBC连接MySQL、Oracle等主流数据库自动将SQL查询结果映射为符合规范的UTF-8编码XML文档并支持自定义根节点、字段命名与嵌套关系省去手写标签、校验格式与调试解析的繁琐环节。1. XML 文件自动生成工具不是写死模板的替换器而是 JDBC 元数据驱动的动态结构生成器你有没有遇到过这种场景新接一个数据库表结构变更频繁的遗留系统每次加字段就要手动改三份 XML——Spring 的datasource配置、MyBatis 的resultMap、还有某中间件要求的元数据描述文件改漏一个服务启动就报Invalid column name查日志要翻半小时。更糟的是当表从 5 张扩到 37 张XML 文件数飙到 120连 diff 都不敢轻易 merge。这个「XML 文件自动生成工具」不是用字符串拼接糊出来的模板引擎它本质是一个轻量级 JDBC 元数据反射器通过真实连接数据库支持 MySQL/PostgreSQL/Oracle读取INFORMATION_SCHEMA或ALL_TAB_COLUMNS把表名、字段名、类型、长度、是否为空、主键标识等结构信息按预设规则映射成符合规范的 XML 片段。它不替代 IDE 的代码生成插件也不做运行时动态解析它的价值在于——一次配置永久同步且所有输出 XML 可直接被 Spring Boot 2.7、MyBatis 3.4.6、以及主流国产中间件识别。适合后端工程师、DBA 协同交付阶段、或需要快速搭建数据接入层的集成项目负责人。如果你还在用 Excel 手动维护字段映射表那它就是你的后悔药。2. 工具原理与核心能力为什么必须基于 JDBC 而非 DDL 解析2.1 为什么不用正则解析 CREATE TABLE 语句很多团队第一反应是“写个脚本 parse DDL SQL”但实操中血泪经验太多Oracle 的NUMBER(10,2)和 PostgreSQL 的NUMERIC(10,2)在 DDL 中写法一致但 JDBCgetJDBCType()返回值不同Types.DECIMALvsTypes.NUMERIC影响后续 XML 中type字段的语义准确性MySQL 5.7 的TINYINT(1)常被业务当布尔用但 DDL 里看不出逻辑含义而 JDBCgetColumnClassName()能返回java.lang.Boolean某些国产数据库如达梦的VARCHAR2类型在 DDL 中无长度声明但实际建表时隐式限制为 2000仅靠 DDL 无法获取该约束。提示本工具强制走 JDBCDatabaseMetaData接口因为它是 JDBC 规范定义的唯一跨厂商元数据访问标准。哪怕底层是闭源数据库只要其 JDBC Driver 实现了getColumns()方法就能拿到真实运行时结构。2.2 核心流程从 Connection 到 XML 的四步链路整个生成过程严格遵循 JDBC 元数据调用链不依赖任何外部 schema 文件或人工输入建立连接并获取元数据对象使用标准DriverManager.getConnection()传入 JDBC URL、用户名、密码调用conn.getMetaData()获取DatabaseMetaData实例。枚举目标表列表调用metaData.getTables(null, schemaPattern, tableNamePattern, new String[]{TABLE})支持通配符如user_%和多 schema如[public,app]。逐表获取字段详情对每个表调用metaData.getColumns(null, schema, table, %)返回ResultSet每行含COLUMN_NAME,DATA_TYPE,COLUMN_SIZE,NULLABLE,COLUMN_DEF,IS_NULLABLE,IS_AUTOINCREMENT,IS_GENERATEDCOLUMN等 20 列。字段到 XML 节点的映射规则不是简单column nameid typeINTEGER/而是根据类型族系做语义增强数值型Types.INTEGER,Types.BIGINT→column nameid typelong javaTypejava.lang.Long jdbcTypeBIGINT/字符型Types.VARCHAR,Types.CHAR→column namename typestring javaTypejava.lang.String jdbcTypeVARCHAR length64/时间型Types.TIMESTAMP,Types.DATE→column namecreate_time typedate javaTypejava.time.LocalDateTime jdbcTypeTIMESTAMP/主键字段自动添加key columnid/子节点2.3 支持的 XML 场景与对应模板标识工具内置 5 类常用 XML 模板通过-t参数指定每类模板对字段属性的取舍和嵌套深度不同模板标识输出用途关键特征是否含 JDBC 属性spring-dsSpring Bootapplication.yml的 datasource 配置片段仅生成bean iddataSource class...及内部property不含表字段否mybatis-rmMyBatisresultMap定义包含id/result节点自动识别主键jdbcType映射精准是ibatis-sqlmapiBatis 2.xsql-map-config.xml片段兼容老系统parameterMap和resultMap分离nullValue属性默认填null是meta-xml通用元数据描述如 ETL 工具接入table nameuser包裹全部column含isPrimaryKeytrue、isNullablefalse属性是jdbc-cfg纯 JDBC 连接参数 XML如 Druid 连接池配置生成druid:config根节点内含url,username,password,driverClassName否注意所有模板均支持${}占位符注入如${db.schema}但占位符解析由调用方负责工具只做字符串原样保留避免与 XML 内容冲突。3. 快速上手三步完成本地生成含完整命令与参数说明3.1 环境准备JDK 8 与 JDBC Driver 的正确放置方式工具为纯 Java 命令行程序JAR 包无需安装但JDBC Driver 必须显式加入 classpath—— 这是新手翻车最高发环节。常见错误把mysql-connector-java-8.0.33.jar放进lib/目录却没在启动命令中引用导致ClassNotFoundException: com.mysql.cj.jdbc.Driver。✅ 正确做法以 MySQL 为例# 下载对应版本 driver务必与数据库大版本匹配 wget https://repo1.maven.org/maven2/mysql/mysql-connector-java/8.0.33/mysql-connector-java-8.0.33.jar # 启动命令必须用 -cp 指定 driver 工具 jar java -cp mysql-connector-java-8.0.33.jar:xml-gen-tool-1.2.0.jar \ com.example.xmlgen.Main \ --url jdbc:mysql://localhost:3306/testdb?useSSLfalseserverTimezoneUTC \ --username root \ --password 123456 \ --schema test \ --table user_info,user_order \ --template mybatis-rm \ --output ./output/逻辑说明-cp参数中 driver jar 必须在工具 jar之前因为 JVM 类加载器按顺序扫描若 driver 在后工具类先加载成功但运行时Class.forName(com.mysql.cj.jdbc.Driver)仍会失败。--table支持逗号分隔多个表名不支持通配符通配符需用--table-pattern。3.2 核心参数详解哪些必须填哪些可省略参数是否必需示例值说明--url✅jdbc:postgresql://192.168.1.100:5432/mydb完整 JDBC URL必须含?后参数如currentSchemapublic--username✅app_user数据库用户名明文传入生产环境建议用配置文件--password⚠️可选但推荐Pssw0rd!若省略运行时交互式输入避免密码泄露到 shell history--schema❌但强烈建议public指定 schema 名MySQL 填数据库名PostgreSQL/Oracle 填 schema 名不填则查所有 schema极慢--table❌二选一t_user,t_order显式指定表名列表逗号分隔无空格--table-pattern❌二选一t_%SQL LIKE 模式如t_log_2023%注意%需 shell 转义--template✅mybatis-rm模板标识见 2.3 表大小写敏感--output✅./gen/输出目录必须存在且有写权限工具不会自动创建父目录--encoding❌默认 UTF-8GBK仅当数据库字符集非 UTF-8 时需指定如旧版 SQL Server参数说明--table和--table-pattern互斥同时出现时--table优先--output路径末尾不能加/否则生成的文件路径会变成./gen//UserMapper.xml双斜杠非法。3.3 生成 MyBatis resultMap 的完整示例假设数据库中有表t_user结构如下CREATE TABLE t_user ( id BIGINT PRIMARY KEY AUTO_INCREMENT, username VARCHAR(64) NOT NULL, email VARCHAR(128), status TINYINT DEFAULT 1, create_time TIMESTAMP DEFAULT CURRENT_TIMESTAMP );执行命令java -cp mysql-connector-java-8.0.33.jar:xml-gen-tool-1.2.0.jar \ com.example.xmlgen.Main \ --url jdbc:mysql://localhost:3306/test?useSSLfalseserverTimezoneUTC \ --username root \ --password 123456 \ --schema test \ --table t_user \ --template mybatis-rm \ --output ./mybatis-maps/生成文件./mybatis-maps/TUserResultMap.xml内容节选?xml version1.0 encodingUTF-8? resultMap idTUserResultMap typecom.example.entity.TUser id propertyid columnid jdbcTypeBIGINT javaTypejava.lang.Long/ result propertyusername columnusername jdbcTypeVARCHAR javaTypejava.lang.String length64/ result propertyemail columnemail jdbcTypeVARCHAR javaTypejava.lang.String length128/ result propertystatus columnstatus jdbcTypeTINYINT javaTypejava.lang.Integer/ result propertycreateTime columncreate_time jdbcTypeTIMESTAMP javaTypejava.time.LocalDateTime/ /resultMap逻辑说明property名称自动转为驼峰create_time→createTimejdbcType严格按DatabaseMetaData.getColumns()返回的DATA_TYPE常量映射Types.TIMESTAMP→TIMESTAMPjavaType则根据类型族系智能推断时间型统一用java.time.*数值型用包装类。length属性仅对字符型字段输出数值型不写MyBatis 会忽略。4. 避坑指南五个真实踩过的坑与根治方案4.1 现象生成的 XML 中jdbcTypeOTHERMyBatis 启动报Unknown JDBC type OTHER原因某些数据库如达梦、人大金仓的 JDBC Driver 对getColumns()返回的DATA_TYPE值未严格遵循 JDBC 规范返回了未注册的整数如20001工具无法映射为标准jdbcType字符串。解决启用类型白名单强制映射。在命令中添加--jdbc-type-mapping参数传入 JSON 映射文件--jdbc-type-mapping ./dm-type-mapping.jsondm-type-mapping.json内容{ 20001: VARCHAR, 20002: BIGINT, 20003: TIMESTAMP }工具启动时会优先查此映射表未命中才 fallback 到默认逻辑。4.2 现象Oracle 表生成的 XML 中columnID全是大写但 Java 实体类字段是idMyBatis 查询结果为 null原因Oracle 默认将未加引号的列名转为大写getColumns()返回的COLUMN_NAME是ID而工具默认直接使用该值作为column属性未做大小写转换。解决使用--column-case参数控制列名大小写策略--column-case lower→columnid--column-case upper→columnIDOracle 默认--column-case original→ 保持数据库原样需确保实体类字段名完全匹配血泪经验Oracle 项目务必加--column-case lower否则 90% 的字段映射失败且错误静默无报错只是值为 null。4.3 现象PostgreSQL 的jsonb字段生成为result ... jdbcTypeOTHER/但实际需用PGobject原因jsonb是 PostgreSQL 扩展类型标准 JDBCTypes中无对应常量Driver 返回DATA_TYPE 2000Types.OTHER但业务代码需用PGobject处理。解决自定义类型处理器映射。在模板配置中非命令行参数为jsonb字段显式指定javaType和handler!-- 在 mybatis-rm 模板中添加 -- typeHandler javaTypecom.fasterxml.jackson.databind.JsonNode handlerorg.apache.ibatis.type.JdbcTypeHandler/工具支持模板内硬编码typeHandler或通过--custom-handler参数传入映射文件JSON 格式将jsonb→JsonNode自动注入。4.4 现象生成的spring-dsXML 中driverClassName为空Spring Boot 启动报Failed to determine embedded database driver class原因工具从 JDBC URL 解析driverClassName但 URL 格式不标准。例如jdbc:mysql://...应解析为com.mysql.cj.jdbc.Driver但若 URL 是jdbc:mariadb://...而工具内置映射表未覆盖 MariaDB。解决用--driver-class参数显式指定--driver-class org.mariadb.jdbc.Driver工具内置映射表覆盖 MySQL/PostgreSQL/Oracle/H2MariaDB、达梦等需手动指定。4.5 现象同一张表多次生成output目录下文件被覆盖但旧文件的 BOMByte Order Mark头丢失导致 UTF-8 文件被某些编辑器识别为 ANSI原因JavaFileWriter默认不写 BOM而 Windows 记事本等工具依赖 BOM 识别 UTF-8。解决启用 BOM 输出开关--bom true工具内部改用OutputStreamWriterStandardCharsets.UTF_8并手动写入0xEF,0xBB,0xBF三字节 BOM。此参数默认falseWindows 环境下建议始终开启。5. 进阶技巧如何让生成的 XML 无缝接入 Spring Boot 多数据源工程5.1 多数据源场景下的 XML 组织策略当工程需对接 MySQL业务库和 PostgreSQL报表库时不能简单把所有表混在一个mybatis-rm模板里。正确做法是按数据源拆分生成目录再用 MyBatis 的MapperScan指定不同 basePackage。步骤为 MySQL 生成java -cp mysql-connector-java-8.0.33.jar:xml-gen-tool-1.2.0.jar \ com.example.xmlgen.Main \ --url jdbc:mysql://mysql-host:3306/app_db \ --username app_rw \ --password pwd1 \ --schema app_db \ --table-pattern t_user% \ --template mybatis-rm \ --output ./src/main/resources/mapper/mysql/为 PostgreSQL 生成java -cp postgresql-42.6.0.jar:xml-gen-tool-1.2.0.jar \ com.example.xmlgen.Main \ --url jdbc:postgresql://pg-host:5432/report_db \ --username report_ro \ --password pwd2 \ --schema public \ --table-pattern rpt_% \ --template mybatis-rm \ --output ./src/main/resources/mapper/postgres/在 Spring Boot 中配置两个 SqlSessionFactoryConfiguration public class MyBatisConfig { Bean(mysqlSqlSessionFactory) public SqlSessionFactory mysqlSqlSessionFactory( Qualifier(mysqlDataSource) DataSource dataSource) throws Exception { SqlSessionFactoryBean factoryBean new SqlSessionFactoryBean(); factoryBean.setDataSource(dataSource); factoryBean.setMapperLocations( new PathMatchingResourcePatternResolver() .getResources(classpath:mapper/mysql/*.xml)); return factoryBean.getObject(); } Bean(postgresSqlSessionFactory) public SqlSessionFactory postgresSqlSessionFactory( Qualifier(postgresDataSource) DataSource dataSource) throws Exception { SqlSessionFactoryBean factoryBean new SqlSessionFactoryBean(); factoryBean.setDataSource(dataSource); factoryBean.setMapperLocations( new PathMatchingResourcePatternResolver() .getResources(classpath:mapper/postgres/*.xml)); return factoryBean.getObject(); } }关键点setMapperLocations()的路径必须与--output目录严格对应且 XML 文件名需符合 MyBatis 命名规范如TUserMapper.xml工具生成的文件名已自动处理表名转 PascalCase。5.2 动态字段注入为 XML 添加环境相关属性生产环境常需在 XML 中注入${env}占位符如property nameurl value${mysql.url}/。工具支持--properties-file参数读取.properties文件并在生成时替换。创建env-dev.propertiesmysql.urljdbc:mysql://dev-db:3306/test mysql.usernamedev_user执行命令--properties-file ./env-dev.properties工具会扫描所有 XML 模板中的${key}占位符如${mysql.url}若key存在于 properties 文件中则替换为对应值否则保留原占位符供 Maven Filter 或 Spring Profile 处理。5.3 与 CI/CD 流水线集成GitLab CI 中自动生成并提交在.gitlab-ci.yml中添加 job每次合并到develop分支时自动生成最新 XMLgenerate-mappers: stage: build image: openjdk:11-jre-slim before_script: - apt-get update apt-get install -y wget - wget https://repo1.maven.org/maven2/mysql/mysql-connector-java/8.0.33/mysql-connector-java-8.0.33.jar script: - java -cp mysql-connector-java-8.0.33.jar:xml-gen-tool-1.2.0.jar \ com.example.xmlgen.Main \ --url $MYSQL_URL \ --username $MYSQL_USER \ --password $MYSQL_PASSWORD \ --schema app \ --table-pattern t_% \ --template mybatis-rm \ --output ./src/main/resources/mapper/generated/ - git config --global user.email ciexample.com - git config --global user.name GitLab CI - git add ./src/main/resources/mapper/generated/ - git commit -m chore: auto-generate mappers from DB schema [skip ci] - git push https://gitlab-ci-token:$CI_JOB_TOKENgitlab.example.com/group/project.git HEAD:develop only: - develop注意$MYSQL_URL等变量需在 GitLab 项目 Settings CI/CD Variables 中预设为 Protected Masked避免密码泄露[skip ci]防止触发无限循环构建。从那以后我每次接手新数据库项目第一件事就是写好generate.sh脚本把 JDBC URL、用户密码、表模式全参数化然后加入 Makefile 的make gen目标。这样团队里任何人 checkout 代码后只需改一行.env文件make gen就能生成全量 XML再也不用担心谁手抖漏改了一个result节点。希望帮到你。本文还有配套的精品资源点击获取