我要评论问：什么是tk.mapper?
答：这是一个通用的mapper框架，相当于把mybatis的常用数据库操作方法封装了一下，它实现了jpa的规范，简单的查询更新和插入操作都可以直接使用其自带的方法，无需写额外的代码。
而且它还有根据实体的不为空的字段插入和更新的方法，这个是非常好用的哈。
而且它的集成非常简单和方便，下面我来演示下使用它怎么自动生成代码。
pom中引入依赖，这里引入tk.mybatis.mapper的版本依赖是因为在mapper-spring-boot-starter的新版本中没有mapperplugin这个类，无法提供代码生成的功能，在老版本中有：
<!--通用mapper--> <dependency> <groupid>tk.mybatis</groupid> <artifactid>mapper-spring-boot-starter</artifactid> <version>2.1.5</version> </dependency> <!--代码生成使用--> <dependency> <groupid>tk.mybatis</groupid> <artifactid>mapper</artifactid> <version>3.4.2</version> </dependency>
配置generatorconfig.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>
<!--执行generator插件生成文件的命令： call mvn mybatis-generator:generate -e -->
<!-- 引入配置文件 -->
<properties resource="generator.properties"/>
<!--classpathentry:数据库的jdbc驱动,换成你自己的驱动位置 可选 -->
<classpathentry
location="d:\iflytek\maven\repository\mysql\mysql-connector-java\8.0.15\mysql-connector-java-8.0.15.jar"/>
<!-- 一个数据库一个context -->
<!--defaultmodeltype="flat" 大数据字段，不分表 -->
<context id="mysqltables" targetruntime="mybatis3simple" defaultmodeltype="flat">
<!-- 自动识别数据库关键字，默认false，如果设置为true，根据sqlreservedwords中定义的关键字列表；
一般保留默认值，遇到数据库关键字（java关键字），使用columnoverride覆盖 -->
<property name="autodelimitkeywords" value="true"/>
<!-- 生成的java文件的编码 -->
<property name="javafileencoding" value="utf-8"/>
<!-- beginningdelimiter和endingdelimiter：指明数据库的用于标记数据库对象名的符号，比如oracle就是双引号，mysql默认是`反引号； -->
<property name="beginningdelimiter" value="`"/>
<property name="endingdelimiter" value="`"/>
<!-- 格式化java代码 -->
<property name="javaformatter" value="org.mybatis.generator.api.dom.defaultjavaformatter"/>
<!-- 格式化xml代码 -->
<property name="xmlformatter" value="org.mybatis.generator.api.dom.defaultxmlformatter"/>
<plugin type="org.mybatis.generator.plugins.serializableplugin"/>
<!--覆盖xml文件-->
<plugin type="com.xqnode.boot.util.overwritexmlplugin"/>
<!--tostring-->
<!--<plugin type="org.mybatis.generator.plugins.tostringplugin"/>-->
<plugin type="tk.mybatis.mapper.generator.mapperplugin">
<property name="mappers" value="tk.mybatis.mapper.common.mapper"/>
</plugin>
<!-- 注释 type="com.xqnode.boot.util.commentgenerator" -->
<commentgenerator>
<property name="suppressallcomments" value="true"/><!-- 是否取消注释 -->
<property name="suppressdate" value="true"/> <!-- 是否生成注释代时间戳-->
</commentgenerator>
<!-- jdbc连接 &表示 & -->
<jdbcconnection driverclass="${jdbc.driverclass}"
connectionurl="${jdbc.connectionurl}"
userid="${jdbc.userid}"
password="${jdbc.password}"/>
<!-- 类型转换 -->
<javatyperesolver>
<!-- 是否使用bigdecimal， false可自动转化以下类型（long, integer, short, etc.） -->
<property name="forcebigdecimals" value="false"/>
</javatyperesolver>
<!-- 生成实体类地址 -->
<javamodelgenerator targetpackage="com.xqnode.boot.model" targetproject="src/main/java">
<property name="enablesubpackages" value="false"/>
<property name="trimstrings" value="true"/>
</javamodelgenerator>
<!-- 生成mapxml文件 -->
<sqlmapgenerator targetpackage="mapper" targetproject="src/main/resources">
<property name="enablesubpackages" value="false"/>
</sqlmapgenerator>
<!-- 生成mapxml对应client，也就是接口dao -->
<javaclientgenerator targetpackage="com.xqnode.boot.dao" targetproject="src/main/java"
type="xmlmapper">
<property name="enablesubpackages" value="false"/>
</javaclientgenerator>
<!-- table可以有多个,每个数据库中的表都可以写一个table，tablename表示要匹配的数据库表,也可以在tablename属性中通过使用%通配符来匹配所有数据库表,只有匹配的表才会自动生成文件 -->
<!-- tablename=% 则匹配数据库的所有表，注意将domainobjectname和mappername置为空-->
<!-- enablecountbyexample等设置生成简单的crud操作方法-->
<table tablename="${table.name}" domainobjectname="${domain.object.name}" mappername="${mapper.name}">
<property name="useactualcolumnnames" value="false"/>
<!-- 数据库表主键 -->
<generatedkey column="id" sqlstatement="mysql" identity="true"/>
</table>
</context>
</generatorconfiguration>
基础配置 generator.properties：
#jdbc jdbc.driverclass=com.mysql.cj.jdbc.driver jdbc.connectionurl=jdbc:mysql://localhost:3306/test?servertimezone=utc&nullcatalogmeanscurrent=true jdbc.userid=root jdbc.password=123456 #project project.name=springboot-mybatis #table table.name=t_user domain.object.name=user mapper.name=usermapper
使用代码的方式生成，工具generatorutil：
package com.xqnode.boot.util;
import org.mybatis.generator.api.mybatisgenerator;
import org.mybatis.generator.config.configuration;
import org.mybatis.generator.config.xml.configurationparser;
import org.mybatis.generator.internal.defaultshellcallback;
import java.io.inputstream;
import java.util.arraylist;
import java.util.list;
/**
* 代码生成工具 具体的配置在generator.properties中
* create by qingxia4 on 2019/3/7 10:56
*/
public class generatorutil {
public static void main(string[] args) throws exception {
//mbg 执行过程中的警告信息
list<string> warnings = new arraylist<>();
//当生成的代码重复时，覆盖原代码
boolean overwrite = true;
//读取我们的 mbg 配置文件
inputstream is = generatorutil.class.getresourceasstream("/generatorconfig.xml");
configurationparser cp = new configurationparser(warnings);
configuration config = cp.parseconfiguration(is);
is.close();
defaultshellcallback callback = new defaultshellcallback(overwrite);
//创建 mbg
mybatisgenerator mybatisgenerator = new mybatisgenerator(config, callback, warnings);
//执行生成代码
mybatisgenerator.generate(null);
//输出警告信息
for (string warning : warnings) {
system.err.println(warning);
}
system.out.println("-----success-----");
}
}
这里还使用了一个覆盖xml的插件overwritexmlplugin，使用这个插件每次新生成的xml文件会完全覆盖老的xml文件，这个插件已经在上面的generatorconfig.xml中配置过了
package com.xqnode.boot.util;
import java.util.list;
import org.mybatis.generator.api.generatedxmlfile;
import org.mybatis.generator.api.introspectedtable;
import org.mybatis.generator.api.pluginadapter;
/**
* @version 1.0.0
*/
public class overwritexmlplugin extends pluginadapter {
@override
public boolean validate(list<string> warnings) {
return true;
}
@override
public boolean sqlmapgenerated(generatedxmlfile sqlmap, introspectedtable introspectedtable) {
sqlmap.setmergeable(false);
return super.sqlmapgenerated(sqlmap, introspectedtable);
}
}
最后，运行generatorutil 的main方法，就可以生成dao、model和mapper.xml文件了。而且生成的代码非常简洁，这是因为tk.mapper代码生成的插件中已经做了相应的处理。生成的结果如下：
使用：
首先在application.yml中配置xml和数据模型的位置：
mybatis: mapper-locations: classpath:mapper/*.xml type-aliases-package: com.xqnode.boot.model
然后在启动类上加上注解@mapperscan(“com.xqnode.boot.dao”)扫描dao的位置，注意这个注解式来自tk.mybatis.spring.annotation包下的，千万别引用错了。
package com.xqnode.boot;
import org.springframework.boot.springapplication;
import org.springframework.boot.autoconfigure.springbootapplication;
import tk.mybatis.spring.annotation.mapperscan;
@springbootapplication
@mapperscan("com.xqnode.boot.dao")
public class application {
public static void main(string[] args) {
springapplication.run(application.class, args);
}
}
现在就可以编写controller测试了：
package com.xqnode.boot.controller;
import cn.hutool.crypto.secureutil;
import com.xqnode.boot.dao.usermapper;
import com.xqnode.boot.model.user;
import org.springframework.web.bind.annotation.*;
import tk.mybatis.mapper.entity.example;
import javax.annotation.resource;
import java.util.date;
import java.util.list;
/**
* created by xiaqing on 2019/3/6 20:11
*/
@restcontroller
@requestmapping("/user")
public class usercontroller {
@resource
private usermapper usermapper;
/**
* 查询所有用户
* @return
*/
@getmapping("/all")
public list<user> findall() {
return usermapper.selectall();
}
/**
* 注册新用户
* @param user
* @return
*/
@postmapping("/registry")
public integer registry(@requestbody user user) {
string pwdmd5 = secureutil.md5(user.getpassword());
user.setpassword(pwdmd5);
user.setcreatetime(new date());
return usermapper.insertselective(user);
}
/**
* 根据登录名修改密码
* @param user
* @return
*/
@putmapping("/changepwd")
public integer changepwd(@requestbody user user) {
string pwdmd5 = secureutil.md5(user.getpassword());
user.setpassword(pwdmd5);
example example = new example(user.class);
example.createcriteria().andequalto("loginname", user.getloginname());
return usermapper.updatebyexampleselective(user, example);
}
}
接口访问测试一下：
测试成功！
以上这篇浅谈springboot中tk.mapper代码生成器的用法说明就是小编分享给大家的全部内容了，希望能给大家一个参考，也希望大家多多支持移动技术网。
您可能感兴趣的文章:
如您对本文有疑问或者有任何想说的，请点击进行留言回复，万千网友为您解惑！
网友评论