文章詳情頁

淺談springboot中tk.mapper代碼生成器的用法說明

瀏覽：120日期：2023-04-19 17:16:09

問：什么是tk.mapper?

答：這是一個通用的mapper框架，相當于把mybatis的常用數(shù)據(jù)庫操作方法封裝了一下，它實現(xiàn)了jpa的規(guī)范，簡單的查詢更新和插入操作都可以直接使用其自帶的方法，無需寫額外的代碼。

而且它還有根據(jù)實體的不為空的字段插入和更新的方法，這個是非常好用的哈。

而且它的集成非常簡單和方便，下面我來演示下使用它怎么自動生成代碼。

pom中引入依賴，這里引入tk.mybatis.mapper的版本依賴是因為在mapper-spring-boot-starter的新版本中沒有MapperPlugin這個類，無法提供代碼生成的功能，在老版本中有：

<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>   <properties resource='generator.properties'/>  <classPathEntry location='D:iflytekmavenrepositorymysqlmysql-connector-java8.0.15mysql-connector-java-8.0.15.jar'/>   <context targetRuntime='MyBatis3Simple' defaultModelType='flat'>  <property name='autoDelimitKeywords' value='true'/>  <property name='javaFileEncoding' value='utf-8'/>  <property name='beginningDelimiter' value='`'/> <property name='endingDelimiter' value='`'/>  <property name='javaFormatter' value='org.mybatis.generator.api.dom.DefaultJavaFormatter'/>  <property name='xmlFormatter' value='org.mybatis.generator.api.dom.DefaultXmlFormatter'/> <plugin type='org.mybatis.generator.plugins.SerializablePlugin'/>  <plugin type='com.xqnode.boot.util.OverwriteXmlPlugin'/>   <plugin type='tk.mybatis.mapper.generator.MapperPlugin'> <property name='mappers' value='tk.mybatis.mapper.common.Mapper'/> </plugin>  <commentGenerator> <property name='suppressAllComments' value='true'/> <property name='suppressDate' value='true'/>  </commentGenerator>  <jdbcConnection driverClass='${jdbc.driverClass}' connectionURL='${jdbc.connectionURL}' userId='${jdbc.userId}' password='${jdbc.password}'/>  <javaTypeResolver>  <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>  <sqlMapGenerator targetPackage='mapper' targetProject='src/main/resources'> <property name='enableSubPackages' value='false'/> </sqlMapGenerator>  <javaClientGenerator targetPackage='com.xqnode.boot.dao' targetProject='src/main/java'type='XMLMAPPER'> <property name='enableSubPackages' value='false'/> </javaClientGenerator>    <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>

基礎(chǔ)配置 generator.properties：

#jdbcjdbc.driverClass=com.mysql.cj.jdbc.Driverjdbc.connectionURL=jdbc:mysql://localhost:3306/test?serverTimezone=UTC&nullCatalogMeansCurrent=truejdbc.userId=rootjdbc.password=123456#projectproject.name=springboot-mybatis#tabletable.name=t_userdomain.object.name=Usermapper.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 執(zhí)行過程中的警告信息 List<String> warnings = new ArrayList<>(); //當生成的代碼重復(fù)時，覆蓋原代碼 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); //創(chuàng)建 MBG MyBatisGenerator myBatisGenerator = new MyBatisGenerator(config, callback, warnings); //執(zhí)行生成代碼 myBatisGenerator.generate(null); //輸出警告信息 for (String warning : warnings) { System.err.println(warning); } System.out.println('-----success-----'); }}

這里還使用了一個覆蓋xml的插件OverwriteXmlPlugin，使用這個插件每次新生成的xml文件會完全覆蓋老的xml文件，這個插件已經(jīng)在上面的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代碼生成的插件中已經(jīng)做了相應(yīng)的處理。生成的結(jié)果如下：

淺談springboot中tk.mapper代碼生成器的用法說明

使用：

首先在application.yml中配置xml和數(shù)據(jù)模型的位置：

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); }}

現(xiàn)在就可以編寫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); } /** * 根據(jù)登錄名修改密碼 * @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代碼生成器的用法說明

測試成功！

以上這篇淺談springboot中tk.mapper代碼生成器的用法說明就是小編分享給大家的全部內(nèi)容了，希望能給大家一個參考，也希望大家多多支持好吧啦網(wǎng)。

Spring

上一條：IDEA 將 SpringBoot 項目打包成jar的方法下一條：SpringBoot集成Druid監(jiān)控頁面最小化配置操作

相關(guān)文章：

1. IntelliJ IDEA配置Tomcat服務(wù)器的方法2. IntelliJ IDEA導(dǎo)入jar包的方法3. docker鏡像完全卸載的操作步驟4. 使用Maven 搭建 Spring MVC 本地部署Tomcat的詳細教程5. IntelliJ IDEA設(shè)置默認瀏覽器的方法6. idea刪除項目的操作方法7. IntelliJ IDEA恢復(fù)刪除文件的方法8. IntelliJ IDEA安裝插件的方法步驟9. idea重置默認配置的方法步驟10. IntelliJ IDEA調(diào)整字體大小的方法

排行榜

					
					docker鏡像完全卸載的操作步驟
IntelliJ IDEA配置Tomcat服務(wù)器的方法
IntelliJ IDEA導(dǎo)入jar包的方法
使用Maven 搭建 Spring MVC 本地部署Tomcat的詳細教程
IntelliJ IDEA恢復(fù)刪除文件的方法
IntelliJ IDEA設(shè)置默認瀏覽器的方法
idea刪除項目的操作方法
IntelliJ IDEA調(diào)整字體大小的方法
IntelliJ IDEA安裝插件的方法步驟
idea打開多個窗口的操作方法
Docker 部署 Prometheus的安裝詳細教程
				