溫馨提示×
您好，登錄后才能下訂單哦！
點擊 登錄注冊 即表示同意《億速云用戶服務條款》
您好，登錄后才能下訂單哦！
今天就跟大家聊聊有關springboot中tk.mapper代碼生成器的使用方法有哪些，可能很多人都不太了解，為了讓大家更加了解，小編給大家總結了以下內容，希望大家根據這篇文章可以有所收獲。
問：什么是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代碼生成器的使用方法有哪些有進一步的了解嗎？如果還想了解更多知識或者相關內容，請關注億速云行業資訊頻道，感謝大家的支持。
免責聲明：本站發布的內容（圖片、視頻和文字）以原創、轉載和分享為主，文章觀點不代表本網站立場，如果涉及侵權請聯系站長郵箱：is@yisu.com進行舉報，并提供相關證據，一經查實，將立刻刪除涉嫌侵權內容。
