经过数据库中的单表,自动生成java代码。Mybatis官方提供了逆向工程,能够针对单表自动生成mybatis代码(mapper.java\mapper.xml\pojo类),实现了ORM,对象关系映射。java
在eclipse中安装Generate插件
mysql
下载安装就是下一步那种web
或者在pom.xml文件中添加mybatis的generator插件spring
<plugin> <groupId>org.mybatis.generator</groupId> <artifactId>mybatis-generator-maven-plugin</artifactId> <version>1.3.2</version> <configuration> <!--关联上面的配置文件 --> <configurationFile>src/main/resources/mybatis-generator/generatorConfig-sys.xml</configurationFile> <verbose>true</verbose> <overwrite>true</overwrite> </configuration> <executions> <execution> <id>Generate MyBatis Artifacts</id> <goals> <goal>generate</goal> </goals> </execution> </executions> <dependencies> <dependency> <groupId>org.mybatis.generator</groupId> <artifactId>mybatis-generator-core</artifactId> <version>1.3.2</version> </dependency> </dependencies> </plugin>
项目类型没有限制,能够是java项目也能够是web项目,或者maven项目均可以。sql
建立一个xml配置文件
数据库
generatorConfiguration.xmlapache
<?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="D:\apache-maven-3.6.1\apache-maven-3.6.1\conf\repository\mysql\mysql-connector-java\5.1.41\mysql-connector-java-5.1.41.jar" /> <context id="DB2Tables" targetRuntime="MyBatis3"> <!-- 去掉生成文件中的注释 --> <commentGenerator> <property name="suppressAllComments" value="true" /> </commentGenerator> <!-- 数据库连接URL、用户名、密码 --> <jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql://localhost:3306/demo" userId="root" password="rootzsl"> </jdbcConnection> <!-- <jdbcConnection driverClass="oracle.jdbc.driver.OracleDriver" connectionURL="jdbc:oracle:thin:@localhost:1521:XE" userId="car" password="car"> </jdbcConnection> --> <javaTypeResolver > <property name="forceBigDecimals" value="false" /> </javaTypeResolver> <!-- 生成模型的包名和位置 当前项目下 ,使用绝对路径,项目名\src\main\java--> <!-- targetPackage="包" targetProject="当前项目下"--> <javaModelGenerator targetPackage="com.zsl.pojo" targetProject="spring-springmvc-mybatis-pojo\src\main\java"> <!-- 是否在当前路径下新加一层schema,eg:false路径com.oop.eksp.user.model, true:com.oop.eksp.user.model.[schemaName] --> <!-- 在targetPackage的基础上,根据数据库的schema再生成一层package,最终生成的类放在这个package下,默认为false --> <property name="enableSubPackages" value="false" /> <!-- 设置是否在getter方法中,对String类型字段调用trim()方法 --> <property name="trimStrings" value="true" /> </javaModelGenerator> <!-- 生成的映射文件包名和位置 --> <!-- targetPackage="包" targetProject="当前项目下"--> <sqlMapGenerator targetPackage="com.zsl.mapper" targetProject="spring-springmvc-mybatis-mapper\src\main\java"> <property name="enableSubPackages" value="false" /> </sqlMapGenerator> <!-- 生成DAO的包名和位置 --> <javaClientGenerator type="XMLMAPPER" targetPackage="com.zsl.mapper" targetProject="spring-springmvc-mybatis-mapper\src\main\java"> <property name="enableSubPackages" value="false" /> </javaClientGenerator> <!-- tableName="数据表" domainObjectName="" --> <table tableName="emp" domainObjectName="Emp" schema=""></table> </context> </generatorConfiguration>
运行,自动生成pojo以及orm映射文件和映射文件的接口
api
生成了pojo类Emp和EmpExample,以及映射文件EmpMapper.xml和EmpMapper接口mybatis
long countByExample(EmpExample example);// 按条件计数 int deleteByExample(EmpExample example);// 按条件进行删除 int deleteByPrimaryKey(Integer empno); // 按主键删除 int insert(Emp record);// 按条件插入数据(返回值为ID) int insertSelective(Emp record);// 按条件插入值不为null的字段 List<Emp> selectByExample(EmpExample example);// 按条件查询 Emp selectByPrimaryKey(Integer empno);// 按主键查询 int updateByExampleSelective(@Param("record") Emp record, @Param("example") EmpExample example);// 按条件更新值不为null的字段 int updateByExample(@Param("record") Emp record, @Param("example") EmpExample example);//按条件更新 int updateByPrimaryKeySelective(Emp record);// 按主键更新值不为null的字段 int updateByPrimaryKey(Emp record);// 按主键更新
二者的区别在于若是选择insert 那么全部的字段都会添加一遍即便没有值,
可是若是使用inserSelective就会只给有值的字段赋值(会对传进来的值作非空判断)。
适用于除了select查询操做的其余xxxx和xxxxSelective。mvc
EmpService
package com.zsl.service.impl; import java.util.List; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Service; import com.zsl.mapper.EmpMapper; import com.zsl.pojo.Emp; import com.zsl.pojo.EmpExample; import com.zsl.pojo.EmpExample.Criteria; import com.zsl.service.IEmpService; @Service public class EmpServiceImpl implements IEmpService { @Autowired private EmpMapper empMapper; @Override public List<Emp> query() { EmpExample example = new EmpExample(); List<Emp> list = empMapper.selectByExample(example); return list; } @Override public List<Emp> queryByName(String ename) { // TODO Auto-generated method stub EmpExample example = new EmpExample(); Criteria criteria = example.createCriteria(); criteria.andEnameLike(ename); List<Emp> list = empMapper.selectByExample(example); return list; } @Override public Integer addEmp(Emp emp) { // TODO Auto-generated method stub int insertSelective = empMapper.insertSelective(emp); return insertSelective; } @Override public Integer updateEmp(Emp emp) { // TODO Auto-generated method stub int updateByPrimaryKey = empMapper.updateByPrimaryKey(emp); return updateByPrimaryKey; } @Override public Integer deleteEmp(Integer empno) { // TODO Auto-generated method stub int deleteByPrimaryKey = empMapper.deleteByPrimaryKey(empno); return deleteByPrimaryKey; } }
Controller
package com.zsl.controller; import java.util.List; import javax.annotation.Resource; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.stereotype.Controller; import org.springframework.web.bind.annotation.PostMapping; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.ResponseBody; import com.zsl.pojo.Emp; import com.zsl.service.IEmpService; @Controller public class TestAction { @Autowired private IEmpService empService; @RequestMapping("/query") @ResponseBody public void query() { // TODO Auto-generated method stub List<Emp> list = empService.query(); for (Emp emp : list) { System.out.println(emp); } } @RequestMapping("/queryByName") @ResponseBody public void queryByName(String ename) { // TODO Auto-generated method stub List<Emp> list = empService.queryByName(ename); for (Emp emp : list) { System.out.println(emp); } } @RequestMapping("/addEmp") @ResponseBody public void addEmp(Emp emp) { // TODO Auto-generated method stub Integer addEmp = empService.addEmp(emp); System.out.println("新增了:"+addEmp); } @RequestMapping("/updateEmp") @ResponseBody public void updateEmp(Emp emp){ Integer updateEmp = empService.updateEmp(emp); System.out.println("修改了:"+updateEmp); } @RequestMapping("/deleteEmp") @ResponseBody public void deleteEmp(Integer empno) { // TODO Auto-generated method stub Integer deleteEmp = empService.deleteEmp(empno); System.out.println("删除了:"+deleteEmp); } }
附上
详细逆向工程配置xml解释说明
<?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> <!-- 能够用于加载配置项或者配置文件,在整个配置文件中就可使用${propertyKey}的方式来引用配置项 resource:配置资源加载地址,使用resource,MBG从classpath开始找,好比com/myproject/generatorConfig.properties url:配置资源加载地质,使用URL的方式,好比file:///C:/myfolder/generatorConfig.properties. 注意,两个属性只能选址一个; 另外,若是使用了mybatis-generator-maven-plugin,那么在pom.xml中定义的properties均可以直接在generatorConfig.xml中使用 <properties resource="" url="" /> --> <!-- 在MBG工做的时候,须要额外加载的依赖包 location属性指明加载jar/zip包的全路径 <classPathEntry location="/Program Files/IBM/SQLLIB/java/db2java.zip" /> --> <!-- context:生成一组对象的环境 id:必选,上下文id,用于在生成错误时提示 defaultModelType:指定生成对象的样式 1,conditional:相似hierarchical; 2,flat:全部内容(主键,blob)等所有生成在一个对象中; 3,hierarchical:主键生成一个XXKey对象(key class),Blob等单独生成一个对象,其余简单属性在一个对象中(record class) targetRuntime: 1,MyBatis3:默认的值,生成基于MyBatis3.x以上版本的内容,包括XXXBySample; 2,MyBatis3Simple:相似MyBatis3,只是不生成XXXBySample; introspectedColumnImpl:类全限定名,用于扩展MBG --> <context id="mysql" defaultModelType="hierarchical" targetRuntime="MyBatis3Simple"> <!-- 自动识别数据库关键字,默认false,若是设置为true,根据SqlReservedWords中定义的关键字列表; 通常保留默认值,遇到数据库关键字(Java关键字),使用columnOverride覆盖 --> <property name="autoDelimitKeywords" value="false" /> <!-- 生成的Java文件的编码 --> <property name="javaFileEncoding" value="UTF-8" /> <!-- 格式化java代码 --> <property name="javaFormatter" value="org.mybatis.generator.api.dom.DefaultJavaFormatter" /> <!-- 格式化XML代码 --> <property name="xmlFormatter" value="org.mybatis.generator.api.dom.DefaultXmlFormatter" /> <!-- beginningDelimiter和endingDelimiter:指明数据库的用于标记数据库对象名的符号,好比ORACLE就是双引号,MYSQL默认是`反引号; --> <property name="beginningDelimiter" value="`" /> <property name="endingDelimiter" value="`" /> <!-- 必需要有的,使用这个配置连接数据库 @TODO:是否能够扩展 --> <jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql:///pss" userId="root" password="admin"> <!-- 这里面能够设置property属性,每个property属性都设置到配置的Driver上 --> </jdbcConnection> <!-- java类型处理器 用于处理DB中的类型到Java中的类型,默认使用JavaTypeResolverDefaultImpl; 注意一点,默认会先尝试使用Integer,Long,Short等来对应DECIMAL和 NUMERIC数据类型; --> <javaTypeResolver type="org.mybatis.generator.internal.types.JavaTypeResolverDefaultImpl"> <!-- true:使用BigDecimal对应DECIMAL和 NUMERIC数据类型 false:默认, scale>0;length>18:使用BigDecimal; scale=0;length[10,18]:使用Long; scale=0;length[5,9]:使用Integer; scale=0;length<5:使用Short; --> <property name="forceBigDecimals" value="false" /> </javaTypeResolver> <!-- java模型建立器,是必需要的元素 负责:1,key类(见context的defaultModelType);2,java类;3,查询类 targetPackage:生成的类要放的包,真实的包受enableSubPackages属性控制; targetProject:目标项目,指定一个存在的目录下,生成的内容会放到指定目录中,若是目录不存在,MBG不会自动建目录 --> <javaModelGenerator targetPackage="com._520it.mybatis.domain" targetProject="src/main/java"> <!-- for MyBatis3/MyBatis3Simple 自动为每个生成的类建立一个构造方法,构造方法包含了全部的field;而不是使用setter; --> <property name="constructorBased" value="false" /> <!-- 在targetPackage的基础上,根据数据库的schema再生成一层package,最终生成的类放在这个package下,默认为false --> <property name="enableSubPackages" value="true" /> <!-- for MyBatis3 / MyBatis3Simple 是否建立一个不可变的类,若是为true, 那么MBG会建立一个没有setter方法的类,取而代之的是相似constructorBased的类 --> <property name="immutable" value="false" /> <!-- 设置一个根对象, 若是设置了这个根对象,那么生成的keyClass或者recordClass会继承这个类;在Table的rootClass属性中能够覆盖该选项 注意:若是在key class或者record class中有root class相同的属性,MBG就不会从新生成这些属性了,包括: 1,属性名相同,类型相同,有相同的getter/setter方法; --> <property name="rootClass" value="com._520it.mybatis.domain.BaseDomain" /> <!-- 设置是否在getter方法中,对String类型字段调用trim()方法 --> <property name="trimStrings" value="true" /> </javaModelGenerator> <!-- 生成SQL map的XML文件生成器, 注意,在Mybatis3以后,咱们可使用mapper.xml文件+Mapper接口(或者不用mapper接口), 或者只使用Mapper接口+Annotation,因此,若是 javaClientGenerator配置中配置了须要生成XML的话,这个元素就必须配置 targetPackage/targetProject:同javaModelGenerator --> <sqlMapGenerator targetPackage="com._520it.mybatis.mapper" targetProject="src/main/resources"> <!-- 在targetPackage的基础上,根据数据库的schema再生成一层package,最终生成的类放在这个package下,默认为false --> <property name="enableSubPackages" value="true" /> </sqlMapGenerator> <!-- 对于mybatis来讲,即生成Mapper接口,注意,若是没有配置该元素,那么默认不会生成Mapper接口 targetPackage/targetProject:同javaModelGenerator type:选择怎么生成mapper接口(在MyBatis3/MyBatis3Simple下): 1,ANNOTATEDMAPPER:会生成使用Mapper接口+Annotation的方式建立(SQL生成在annotation中),不会生成对应的XML; 2,MIXEDMAPPER:使用混合配置,会生成Mapper接口,并适当添加合适的Annotation,可是XML会生成在XML中; 3,XMLMAPPER:会生成Mapper接口,接口彻底依赖XML; 注意,若是context是MyBatis3Simple:只支持ANNOTATEDMAPPER和XMLMAPPER --> <javaClientGenerator targetPackage="com._520it.mybatis.mapper" type="ANNOTATEDMAPPER" targetProject="src/main/java"> <!-- 在targetPackage的基础上,根据数据库的schema再生成一层package,最终生成的类放在这个package下,默认为false --> <property name="enableSubPackages" value="true" /> <!-- 能够为全部生成的接口添加一个父接口,可是MBG只负责生成,不负责检查 <property name="rootInterface" value=""/> --> </javaClientGenerator> <!-- 选择一个table来生成相关文件,能够有一个或多个table,必需要有table元素 选择的table会生成一下文件: 1,SQL map文件 2,生成一个主键类; 3,除了BLOB和主键的其余字段的类; 4,包含BLOB的类; 5,一个用户生成动态查询的条件类(selectByExample, deleteByExample),可选; 6,Mapper接口(可选) tableName(必要):要生成对象的表名; 注意:大小写敏感问题。正常状况下,MBG会自动的去识别数据库标识符的大小写敏感度,在通常状况下,MBG会 根据设置的schema,catalog或tablename去查询数据表,按照下面的流程: 1,若是schema,catalog或tablename中有空格,那么设置的是什么格式,就精确的使用指定的大小写格式去查询; 2,不然,若是数据库的标识符使用大写的,那么MBG自动把表名变成大写再查找; 3,不然,若是数据库的标识符使用小写的,那么MBG自动把表名变成小写再查找; 4,不然,使用指定的大小写格式查询; 另外的,若是在建立表的时候,使用的""把数据库对象规定大小写,就算数据库标识符是使用的大写,在这种状况下也会使用给定的大小写来建立表名; 这个时候,请设置delimitIdentifiers="true"便可保留大小写格式; 可选: 1,schema:数据库的schema; 2,catalog:数据库的catalog; 3,alias:为数据表设置的别名,若是设置了alias,那么生成的全部的SELECT SQL语句中,列名会变成:alias_actualColumnName 4,domainObjectName:生成的domain类的名字,若是不设置,直接使用表名做为domain类的名字;能够设置为somepck.domainName,那么会自动把domainName类再放到somepck包里面; 5,enableInsert(默认true):指定是否生成insert语句; 6,enableSelectByPrimaryKey(默认true):指定是否生成按照主键查询对象的语句(就是getById或get); 7,enableSelectByExample(默认true):MyBatis3Simple为false,指定是否生成动态查询语句; 8,enableUpdateByPrimaryKey(默认true):指定是否生成按照主键修改对象的语句(即update); 9,enableDeleteByPrimaryKey(默认true):指定是否生成按照主键删除对象的语句(即delete); 10,enableDeleteByExample(默认true):MyBatis3Simple为false,指定是否生成动态删除语句; 11,enableCountByExample(默认true):MyBatis3Simple为false,指定是否生成动态查询总条数语句(用于分页的总条数查询); 12,enableUpdateByExample(默认true):MyBatis3Simple为false,指定是否生成动态修改语句(只修改对象中不为空的属性); 13,modelType:参考context元素的defaultModelType,至关于覆盖; 14,delimitIdentifiers:参考tableName的解释,注意,默认的delimitIdentifiers是双引号,若是相似MYSQL这样的数据库,使用的是`(反引号,那么还须要设置context的beginningDelimiter和endingDelimiter属性) 15,delimitAllColumns:设置是否全部生成的SQL中的列名都使用标识符引发来。默认为false,delimitIdentifiers参考context的属性 注意,table里面不少参数都是对javaModelGenerator,context等元素的默认属性的一个复写; --> <table tableName="userinfo"> <!-- 参考 javaModelGenerator 的 constructorBased属性 --> <property name="constructorBased" value="false" /> <!-- 默认为false,若是设置为true,在生成的SQL中,table名字不会加上catalog或schema; --> <property name="ignoreQualifiersAtRuntime" value="false" /> <!-- 参考 javaModelGenerator 的 immutable 属性 --> <property name="immutable" value="false" /> <!-- 指定是否只生成domain类,若是设置为true,只生成domain类,若是还配置了sqlMapGenerator,那么在mapper XML文件中,只生成resultMap元素 --> <property name="modelOnly" value="false" /> <!-- 参考 javaModelGenerator 的 rootClass 属性 <property name="rootClass" value=""/> --> <!-- 参考javaClientGenerator 的 rootInterface 属性 <property name="rootInterface" value=""/> --> <!-- 若是设置了runtimeCatalog,那么在生成的SQL中,使用该指定的catalog,而不是table元素上的catalog <property name="runtimeCatalog" value=""/> --> <!-- 若是设置了runtimeSchema,那么在生成的SQL中,使用该指定的schema,而不是table元素上的schema <property name="runtimeSchema" value=""/> --> <!-- 若是设置了runtimeTableName,那么在生成的SQL中,使用该指定的tablename,而不是table元素上的tablename <property name="runtimeTableName" value=""/> --> <!-- 注意,该属性只针对MyBatis3Simple有用; 若是选择的runtime是MyBatis3Simple,那么会生成一个SelectAll方法,若是指定了selectAllOrderByClause,那么会在该SQL中添加指定的这个order条件; --> <property name="selectAllOrderByClause" value="age desc,username asc" /> <!-- 若是设置为true,生成的model类会直接使用column自己的名字,而不会再使用驼峰命名方法,好比BORN_DATE,生成的属性名字就是BORN_DATE,而不会是bornDate --> <property name="useActualColumnNames" value="false" /> <!-- generatedKey用于生成生成主键的方法, 若是设置了该元素,MBG会在生成的<insert>元素中生成一条正确的<selectKey>元素,该元素可选 column:主键的列名; sqlStatement:要生成的selectKey语句,有如下可选项: Cloudscape:至关于selectKey的SQL为: VALUES IDENTITY_VAL_LOCAL() DB2 :至关于selectKey的SQL为: VALUES IDENTITY_VAL_LOCAL() DB2_MF :至关于selectKey的SQL为:SELECT IDENTITY_VAL_LOCAL() FROM SYSIBM.SYSDUMMY1 Derby :至关于selectKey的SQL为:VALUES IDENTITY_VAL_LOCAL() HSQLDB :至关于selectKey的SQL为:CALL IDENTITY() Informix :至关于selectKey的SQL为:select dbinfo('sqlca.sqlerrd1') from systables where tabid=1 MySql :至关于selectKey的SQL为:SELECT LAST_INSERT_ID() SqlServer :至关于selectKey的SQL为:SELECT SCOPE_IDENTITY() SYBASE :至关于selectKey的SQL为:SELECT @@IDENTITY JDBC :至关于在生成的insert元素上添加useGeneratedKeys="true"和keyProperty属性 <generatedKey column="" sqlStatement=""/> --> <!-- 该元素会在根据表中列名计算对象属性名以前先重命名列名,很是适合用于表中的列都有公用的前缀字符串的时候, 好比列名为:CUST_ID,CUST_NAME,CUST_EMAIL,CUST_ADDRESS等; 那么就能够设置searchString为"^CUST_",并使用空白替换,那么生成的Customer对象中的属性名称就不是 custId,custName等,而是先被替换为ID,NAME,EMAIL,而后变成属性:id,name,email; 注意,MBG是使用java.util.regex.Matcher.replaceAll来替换searchString和replaceString的, 若是使用了columnOverride元素,该属性无效; <columnRenamingRule searchString="" replaceString=""/> --> <!-- 用来修改表中某个列的属性,MBG会使用修改后的列来生成domain的属性; column:要从新设置的列名; 注意,一个table元素中能够有多个columnOverride元素哈~ --> <columnOverride column="username"> <!-- 使用property属性来指定列要生成的属性名称 --> <property name="property" value="userName" /> <!-- javaType用于指定生成的domain的属性类型,使用类型的全限定名 <property name="javaType" value=""/> --> <!-- jdbcType用于指定该列的JDBC类型 <property name="jdbcType" value=""/> --> <!-- typeHandler 用于指定该列使用到的TypeHandler,若是要指定,配置类型处理器的全限定名 注意,mybatis中,不会生成到mybatis-config.xml中的typeHandler 只会生成相似:where id = #{id,jdbcType=BIGINT,typeHandler=com._520it.mybatis.MyTypeHandler}的参数描述 <property name="jdbcType" value=""/> --> <!-- 参考table元素的delimitAllColumns配置,默认为false <property name="delimitedColumnName" value=""/> --> </columnOverride> <!-- ignoreColumn设置一个MGB忽略的列,若是设置了改列,那么在生成的domain中,生成的SQL中,都不会有该列出现 column:指定要忽略的列的名字; delimitedColumnName:参考table元素的delimitAllColumns配置,默认为false 注意,一个table元素中能够有多个ignoreColumn元素 <ignoreColumn column="deptId" delimitedColumnName=""/> --> </table> </context> </generatorConfiguration>