本项目最初想要解决数据库表名、字段名的命名法与 java 的类、属性命名法不一致带来的一系列问题。
当然,本项目的 MBG 扩展类还做了一些其他事情,比如方便分表时做表名替换,更详细的,请参考: MBG 扩展类 module
曾尝试将数据库表名、字段名也采用驼峰命名法。
现在已经改成:
已添加查询示例,不过仅仅是查询示例,没有考虑到项目架构的合理性。实际项目不会在 web 层直接调用 dal 层,实际项目会有业务层和接口层。
有关 MySQL 命名规范,请参考:MyBatis 项目中,有关 MySQL 命名规范,用驼峰命名法与下划线命名法的取舍,请关注这篇文章提到的 mapUnderscoreToCamelCase 配置项。
boot-create-table-property/resources/schema.sql
脚本。boot-create-table-property/resources/application.yml
中的数据库连接参数。boot-create-table-property
。generatorConfig.xml
,重新生成 mapperdemo.domain.dal.service.SysDeptDalService.getSysDeptList()
实现数据库查询方法。table.property.controller.QueryDatabaseTestController.getSysDeptList()
运行查询测试。更新时间:2019-05-29
近期,又研读了一次《阿里巴巴Java开发手册(详尽版)》(从这里可以下载),又思考了关于 MySQL 的表名、字段名的命名范围。
打算在以后的新项目中完全遵循《阿里巴巴Java开发手册(详尽版)》的规范。
与本仓库的 MySQL 表名、字段名,采用的是驼峰命名法(CamelCase),与《阿里巴巴Java开发手册(详尽版)》的规范冲突,需要改为下划线命名法(UnderScoreCase)。
关于数据库表名、字段名的命名规范,是要采用与 Java 代码的字段名和方法名一样的驼峰命名法(CamelCase)还是采用业界绝大多数团队使用的下划线命名法(UnderScoreCase),仁者见仁,智者见智。
作为团队规范的制定者,需要综合考虑各个方面的因素,之前我在面对这个问题的时候,考虑到数据库的每一张表都会对应一个 POJO,如果表字段是下划线命名法,为了与数据库对应,表对应的实体类(POJO)也得下划线命名,这就导致了同样是 java 类的命名规范的不一致性,在写代码的时候很别扭(当时对 MyBatis 不熟悉,其实有解决方案,继续往下看)。
现在如果有一个方案,在既保持数据库表与字段采用下划线命名法的同时,对应实体(POJO)又是驼峰命名法,这样既可以兼顾数据库的业界规范,又可以兼顾 Java 开发的业界规范,那就太完美了,还好,这个方案是有的。
请继续往下看。
更新时间:2019-06-18
针对数据库字段使用下划线命名法,生成相应实体时,使用 java 普遍使用的驼峰命名法的配置,将 boot-create-table-property 项目的 application.yml 的配置 flagUseActualColumnNames
改为 false:
# 是否使用原始字段名
flagUseActualColumnNames: false
如果设置为 true,会生成如下属性:
<property name="useActualColumnNames" value="true"/>
设置为 false 则不会生成该属性,没有显示指定该属性值时,该属性默认为 false。MyBatis Generator 默认会把下划线命名法转换成驼峰命名法。
只是,以上配置,需要配合 MyBatis 的 mapUnderscoreToCamelCase
配置属性,需要将其设置为 true,在文件 mybatis-config.xml
中配置:
<configuration>
<settings>
<!-- 开启驼峰映射,为自定义的SQL语句服务-->
<!-- 设置启用数据库字段下划线映射到 java POJO 的驼峰式命名属性,默认值为 false-->
<!-- 即从经典数据库列名 a_column 到经典 Java 属性名 aColumn 的类似映射 -->
<!-- 配置后无需写 resultMap 将数据库字段和实体类属性对应 -->
<setting name="mapUnderscoreToCamelCase" value="true"/>
</settings>
</configuration>
两种方式
boot-create-table-property
工程采用 spring boot v2.1.5 创建,可直接运行,运行之后,访问:http://localhost:90/getTableProperties
WithApplicationContextTest.getTablePropertiesTest
,从控制台查看。如果觉得不错,欢迎star以表支持。
cmd窗口运行jar文件,可以直接用本项目根目录下的两个jar文件和配置文件,稍作修改应该就可以用了。
mybatis-generator-1.3.7.jar
备用。mybatis-generator-enhance.jar
。java -Dfile.encoding=UTF-8 -cp mybatis-generator-1.3.7.jar;mybatis-generator-enhance.jar org.mybatis.generator.api.ShellRunner -configfile generatorConfig.xml -overwrite
这里通过 -cp 指定需要用到的所有jar包,用分号隔开,这样在运行的时候才能找到相应的类。
<java.version>11</java.version>
为 <java.version>1.8</java.version>
。boot-create-table-property/resources/schema.sql
boot-create-table-property
boot-create-table-property/resources/mbg.pdm
demo.domain.dal.service.SysDeptDalService.getSysDeptList()
com.mysql.jdbc.Driver
改为com.mysql.cj.jdbc.Driver
了。mybatis-generator-enhance.jar
改名为 mybatis-generator-enhance-mysql-v5.7.x.jar
,同时增加支持 MySQL 8.x 的包 mybatis-generator-enhance-mysql-v8.x.jar
。mysql-connector-java 8.0.13
不变的情况下,数据库由8.x换到5.7.x之后,现出以下两类错误:
Cannot obtain primary key information from the database, generated objects may be incomplete
...
deleteByPrimaryKey
selectByPrimaryKey
updateByPrimaryKeySelective
updateByPrimaryKey
mysql-connector-java
由高版本的8.X换成低版本的5.1.x。高版本8.x的驱动连接8.x数据库是正常的,但是换成低版本的数据库5.7.x版本,就会有问题。参考
CreateTablePropertyService
,优化完善了相关代码、添加数据库的各种配置信息,更易于使用和维护。CreateTablePropertyService
单独提取至一个独立的项目,以尽可能少的修改官方项目mybatis-generator-core
源码。官方文档:Identifier Case Sensitivity
参数说明
lower_case_table_names=0
表名存储为给定的大小写。比较时:区分大小写。大小写敏感(Unix,Linux默认)。创建的库表将原样保存在磁盘上。如create database TeSt;将会创建一个TeSt的目录,create table AbCCC ...将会原样生成AbCCC.frm。SQL语句也会原样解析。
lower_case_table_names=1
表名存储为小写。比较时:不区分大小写。大小写不敏感(Windows默认)。创建的库表时,MySQL将所有的库表名转换成小写存储在磁盘上。SQL语句同样会将库表名转换成小写。如需要查询以前创建的Test_table(生成Test_table.frm文件),即便执行select * from Test_table,也会被转换成select * from test_table,致使报错表不存在。
lower_case_table_names=2
表名存储为给定的大小写。比较时:小写。创建的库表将原样保存在磁盘上。但SQL语句将库表名转换成小写。
如果开发环境、生产环境均配置成1或者2,则本文中有关大小写敏感的措施都是无意义的。
但是如果分库时依赖表名替换,则又是适用的,见以下【适用场景】中的场景二。
最终目标:MBG 生成的xml文件中的sql脚本的表名,保持与对应表名在建表时的大小写一致,保持大小写敏感(表名可在MBG需要的配置文件中配置,以该配置为准)。这样可以适应以上lower_case_table_names
的三种配置值。
为了达到以上目标,运行生成表配置内容的项目,一定要连接参数lower_case_table_names
配置为0或者2的数据库服务器,并且是配置为0或者2之后才创建的数据表,否则,生成的表配置内容的表名,是以全部小写为基准的,并非驼峰式命名法。表配置内容生成好之后,重新生成 mapper 时连接的数据库服务器的lower_case_table_names
配置值,对生成结果没有影响。
lower_case_table_names=1
,且该参数不能修改。lower_case_table_names
的linux服务器,就可以将该参数设置为0,即大小写敏感。lower_case_table_names=0
(linux)或者lower_case_table_names=2
(windows)的情况。当然,读到这里,你可能会觉得奇怪,数据库的库名、表名、字段名,业界都是用下划线分开的,其余字母全是小写,所以,该参数被配置成什么都不需要关心。
如果你也这么认为,那么,本文对你是没有价值的。
本文要解决的问题是,数据库的库名、表名、字段名,需要保持跟 Java 的编码规范一致的场景。如果都统一成一种编码规则,比如统一用驼峰式命名法,那么,不用在两种编码习惯上切换,可以提高编码效率和减少不必要的麻烦,且继续往下看。
erpTrade
表分成了120个表,那么在某一次业务操作中,需要将erpTrade
替换成erpTrade_xyz
,其中xyz
为从001
到120
的其中一个数字,则需要将MBG生成的xml里sql脚本中的表名用 `(左上角数字键1左边、Tab键上边、Esc键下边的键)引起来。将会分享我的基于 MyBatis 插件分库分表项目。
lower_case_table_names=1
或者该参数未配置(未配置的时候默认为1),运行MBG,生成的sql脚本,全是小写,需要花费额外时间来解决环境问题。MBG 基于一个 xml 配置文件,在这个配置文件里,有跟表相关的配置,为了达到我的需求,需要一张表对应一行配置信息,所以,我写了一个类来自动生成,这样,在增减表,或者别的项目里面,可以简单的运行这个类来生成,减少手工劳动。
更详细的,请看:https://github.com/uncleAndyChen/mybatis-generator/tree/master/boot-create-table-property
MBG需要的配置文件比较全面的,在工作中实际用到的文件内容如下:
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE generatorConfiguration
PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"
"http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd">
<generatorConfiguration>
<!--数据库驱动-->
<classPathEntry location="mysql-connector-java-5.1.31.jar"/>
<!--<context id="DB2Tables" targetRuntime="MyBatis3">-->
<!--如果你希望不生成和Example查询有关的内容,那么可以按照如下进行配置:-->
<!--<context id="DB2Tables" targetRuntime="MyBatis3Impl">-->
<context id="Mysql" targetRuntime="MyBatis3" defaultModelType="flat">
<!--<context id="Mysql" targetRuntime="MyBatis3Simple" defaultModelType="flat">-->
<commentGenerator>
<property name="suppressDate" value="true"/>
<property name="suppressAllComments" value="true"/>
</commentGenerator>
<!--数据库链接地址账号密码-->
<jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql://192.168.0.130:3306/mbg?useUnivalue=true&characterEncoding=utf8&autoReconnect=true&failOverReadOnly=false"
userId="root" password="root">
<property name="nullCatalogMeansCurrent" value="true"/>
</jdbcConnection>
<javaTypeResolver>
<property name="forceBigDecimals" value="false"/>
</javaTypeResolver>
<!--生成Model类存放位置-->
<javaModelGenerator targetPackage="mybatis.generator.model.entity" targetProject="mybatis.generator.model/src/main/java/">
<property name="enableSubPackages" value="true"/>
<property name="trimStrings" value="true"/>
</javaModelGenerator>
<!--生成映射文件存放位置-->
<sqlMapGenerator targetPackage="mappers\original" targetProject="mybatis.generator.dal\src\main\resources">
<property name="enableSubPackages" value="true"/>
</sqlMapGenerator>
<!--生成Dao类存放位置
当type=XMLMAPPER时,会生成一个XXX.xml文件内有各种sql语句,是mapper的实现。
当type=ANNOTATEDMAPPER时,会直接在mapper接口上添加注释。
-->
<!--
http://blog.csdn.net/qq_27376871/article/details/51360638
MyBatis3:
ANNOTATEDMAPPER:基于注解的Mapper接口,不会有对应的XML映射文件
MIXEDMAPPER:XML和注解的混合形式,(上面这种情况中的)SqlProvider注解方法会被XML替代。
XMLMAPPER:所有的方法都在XML中,接口调用依赖XML文件。
MyBatis3Simple:
ANNOTATEDMAPPER:基于注解的Mapper接口,不会有对应的XML映射文件
XMLMAPPER:所有的方法都在XML中,接口调用依赖XML文件。
-->
<javaClientGenerator type="XMLMAPPER" targetPackage="mybatis.generator.dal.mapper"
targetProject="mybatis.generator.dal/src/main/java/">
<property name="enableSubPackages" value="true"/>
</javaClientGenerator>
<!--生成对应表及类名-->
<table tableName="erpEnterpriseMember" domainObjectName="EnterpriseMember"><property name="useActualColumnNames" value="true"/><generatedKey identity="true" type="post" column="memberID" sqlStatement="Mysql"/></table>
<table tableName="erpShopConfig" domainObjectName="ShopConfig"><property name="useActualColumnNames" value="true"/><generatedKey identity="true" type="post" column="ID" sqlStatement="Mysql"/></table>
<table tableName="erpTrade" domainObjectName="erpTrade"><property name="useActualColumnNames" value="true"/><generatedKey identity="true" type="post" column="tradeID" sqlStatement="Mysql"/></table>
</context>
</generatorConfiguration>
# 注意:*Mapper.xml 文件,每次重新生成都需要先删除,否则部分内容会重复生成,导致错误,版本1.3.5以及现在最新版1.3.7均有此问题。
# 执行之前请确保文件路径是正确的。
# 以下三行执行删除生成的所有文件
del/f/s/q C:\workspace\mybatis-generator\demo-domain-dal\src\main\java\demo\domain\dal\mapper\original\*.*
del/f/s/q C:\workspace\mybatis-generator\demo-domain-dal\src\main\java\demo\domain\dal\mapper\xml\original\*.xml
del/f/s/q C:\workspace\mybatis-generator\demo-domain-model\src\main\java\demo\domain\model\entity\*.*
# 以下语句生成 mapper,分别针对 MySQL 的两个版本,执行时请注意 MySQL 的 driverClass 值。
# 针对 MySQL v8.x,执行前,请确保本文件中 driverClass 的值为:com.mysql.cj.jdbc.Driver
java -Dfile.encoding=UTF-8 -cp mybatis-generator-1.3.7.jar;mybatis-generator-enhance-mysql-v8.x.jar org.mybatis.generator.api.ShellRunner -configfile generatorConfig.xml -overwrite
# 针对 MySQL v5.7.x(理论上,v5.7 以前的版本也是支持的,没测试),执行前,请确保本文件中 driverClass 的值为:com.mysql.jdbc.Driver
java -Dfile.encoding=UTF-8 -cp mybatis-generator-1.3.7.jar;mybatis-generator-enhance-mysql-v5.7.x.jar org.mybatis.generator.api.ShellRunner -configfile generatorConfig.xml -overwrite
如果库里有一张 user,在用 MBG 生成代码文件的时候,可能会遇到类似如下的提示信息:
Table Configuration user matched more than one table (forTest..user,mysql..user,xunwu..user,bbs..user)
Column userId, specified as an identity column in table user, does not exist in the table.
Column userId, specified as an identity column in table user, does not exist in the table.
Column userId, specified as an identity column in table user, does not exist in the table.
意思是,在多个库里都存在 user 表,而其中有三个库中的 user 表不存在 userId 这个字段。
所以,在作业务表设计的时候,最好给所有表名加上能区别业务的前缀,这样可以有效避免与其它库的表名冲突,这样做不光是为了适应 MBG,在做业务开发的时候同样会带来好处。在做类设计的时候,适当的添加前缀或者后缀,也能让人一下子知道类的作用,这需要在实际工作中才能体会到。
当然,针对 MBG 的这个问题,是有解决办法的:
jdbcConnection
项下添加:<property name="nullCatalogMeansCurrent" value="true"/>
可以解决(注:本文中的配置示例已添加)。<table catalog="mbg" tableName="sys_dept" domainObjectName="SysDept"><generatedKey identity="true" type="post" column="id" sqlStatement="Mysql"/><columnOverride column="status" javaType="java.lang.Integer" jdbcType="INTEGER" /></table>
更详细的,请参考:解决 mybatis generator 使用新版 mysql 驱动 8.0 版本时会生成用户下多个库里的表的问题
此处可能存在不合适展示的内容,页面不予展示。您可通过相关编辑功能自查并修改。
如您确认内容无涉及 不当用语 / 纯广告导流 / 暴力 / 低俗色情 / 侵权 / 盗版 / 虚假 / 无价值内容或违法国家有关法律法规的内容,可点击提交进行申诉,我们将尽快为您处理。