springboot整合tkMapper

想着每次搭建新项目时框架都要从新搭建，基本常用的也就哪几种，现在就来搭建一种常用的springboot后台框架，以后新开小项目可以直接拿来使用
项目整体结构图

1.新建springboot空白项目，选中web依赖（略，也可以完全根据本人代码操作）
2.pom文件依赖项展示

<?xml version="1.0" encoding="UTF-8"?><project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"         xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">    <modelVersion>4.0.0</modelVersion>    <parent>        <groupId>org.springframework.boot</groupId>        <artifactId>spring-boot-starter-parent</artifactId>        <version>2.1.5.RELEASE</version>        <relativePath/> <!-- lookup parent from repository -->    </parent>    <groupId>com.cxt</groupId>    <artifactId>demo</artifactId>    <version>0.0.1-SNAPSHOT</version>    <name>demo</name>    <description>Demo project for Spring Boot</description>    <properties>        <java.version>1.8</java.version>    </properties>    <dependencies>        <dependency>            <groupId>org.springframework.boot</groupId>            <artifactId>spring-boot-starter-web</artifactId>        </dependency>        <dependency>            <groupId>org.projectlombok</groupId>            <artifactId>lombok</artifactId>            <optional>true</optional>        </dependency>        <dependency>            <groupId>org.springframework.boot</groupId>            <artifactId>spring-boot-starter-test</artifactId>            <scope>test</scope>        </dependency>        <!--spring-boot mybatis依赖-->        <dependency>            <groupId>org.mybatis.spring.boot</groupId>            <artifactId>mybatis-spring-boot-starter</artifactId>            <version>1.3.2</version>        </dependency>        <!--mysql依赖-->        <dependency>            <groupId>mysql</groupId>            <artifactId>mysql-connector-java</artifactId>            <version>8.0.16</version>            <scope>runtime</scope>        </dependency>        <!-- tk-->        <dependency>            <groupId>tk.mybatis</groupId>            <artifactId>mapper-spring-boot-starter</artifactId>            <version>RELEASE</version>        </dependency>        <dependency>            <groupId>tk.mybatis</groupId>            <artifactId>mapper</artifactId>            <version>3.4.5</version>        </dependency>        <!--druid依赖-->        <dependency>            <groupId>com.alibaba</groupId>            <artifactId>druid</artifactId>            <version>1.1.3</version>        </dependency>    </dependencies>    <build>        <plugins>            <plugin>                <groupId>org.springframework.boot</groupId>                <artifactId>spring-boot-maven-plugin</artifactId>            </plugin>            <!--添加mybatis generator maven插件 -->            <plugin>                <groupId>org.mybatis.generator</groupId>                <artifactId>mybatis-generator-maven-plugin</artifactId>                <version>1.3.2</version>                <configuration>                    <configurationFile>${basedir}/src/main/resources/generator/generatorConfig.xml</configurationFile>                    <overwrite>true</overwrite>                    <verbose>true</verbose>                </configuration>                <dependencies>                    <dependency>                        <groupId>mysql</groupId>                        <artifactId>mysql-connector-java</artifactId>                        <version>8.0.16</version>                    </dependency>                    <dependency>                        <groupId>tk.mybatis</groupId>                        <artifactId>mapper-generator</artifactId>                        <version>1.1.3</version>                    </dependency>                </dependencies>            </plugin>        </plugins>    </build></project>
  1. application.yml文件内容
server:  port: 8081#数据源配置spring:  datasource:    type: com.alibaba.druid.pool.DruidDataSource #Druid连接池    url: jdbc:mysql://localhost:3306/springboot-demo?useUnicode=true&characterEncoding=UTF-8&zeroDateTimeBehavior=convertToNull&useSSL=true&nullCatalogMeansCurrent=true    username: root #数据库用户名    password: root #数据库密码    driver-class-name: com.mysql.cj.jdbc.Driver #mysql驱动    initialSize: 10 #初始化连接池大小    minIdle: 10 #初始化最小连接池数量    maxActive: 100 #初始化最大连接池数量    maxWait: 6000 #配置获取连接等待超时的时间    timeBetweenEvictionRunsMills: 6000 #配置间隔多久才进行一次检测，检测需要关闭的空闲连接，单位是毫秒    minEvictableIdleTimeMillis: 30000 #配置一个连接在池中最小生存的时间，单位是毫秒    validationQuery: SELECT 'x' #测试连接mybatis:  mapper-locations: classpath:/mapper/*.xml  configuration:    map-underscore-to-camel-case: true    #打印sql    #log-impl: org.apache.ibatis.logging.stdout.StdOutImplmapper:  identity: MYSQL # 配置主键自动增长(使用MYSQL原生方式)logging:  level:    com.cxt.demo: debug# 分页插件pagehelper:  reasonable: true  page-size-zero: true  params: pageNum=start;pageSize=limit  support-methods-arguments: true
  1. 新建MyBaseMapper，（ 注意此接口不能被扫描到 *）
package com.cxt.demo.tk;import org.springframework.stereotype.Repository;import tk.mybatis.mapper.common.ExampleMapper;import tk.mybatis.mapper.common.Mapper;import tk.mybatis.mapper.common.MySqlMapper;/** * @author liBai * @Classname MyBaseMapper * @Description TODO base mapper 不能被扫描 * @Date 2019-06-02 10:41 */@Repositorypublic interface MyBaseMapper<T>  extends Mapper<T>, MySqlMapper<T> , ExampleMapper<T> {}
  1. 启动类添加扫描mapper

注意此处@MapperScan要引tk包下面的，否则会报错
（import tk.mybatis.spring.annotation.MapperScan;）

package com.cxt.demo;import org.springframework.boot.SpringApplication;import org.springframework.boot.autoconfigure.SpringBootApplication;import tk.mybatis.spring.annotation.MapperScan;/** * @author liBai * mapperscan 要引tk包下面的 */@SpringBootApplication@MapperScan(basePackages = "com.cxt.demo.dao")public class DemoApplication {    public static void main(String[] args) {        SpringApplication.run(DemoApplication.class, args);    }}
  1. 添加MybatisConfigurer配置类
package com.cxt.demo.config;import org.apache.ibatis.session.SqlSessionFactory;import org.mybatis.spring.SqlSessionFactoryBean;import org.springframework.boot.SpringBootConfiguration;import org.springframework.context.annotation.Bean;import javax.annotation.Resource;import javax.sql.DataSource;/** * @author liBai * @Classname MybatisConfigurer * @Description TODO * @Date 2019-06-02 10:42 */@SpringBootConfigurationpublic class MybatisConfigurer {    @Resource    private DataSource dataSource;    @Bean    public SqlSessionFactory sqlSessionFactoryBean() throws Exception {        SqlSessionFactoryBean bean = new SqlSessionFactoryBean();        bean.setDataSource(dataSource);        bean.setTypeAliasesPackage("com.cxt.demo.bean");        return bean.getObject();    }}
  1. 数据库创建sql语句（测试tkmapper链接数据库）
CREATE TABLE `test_sys` (  `id` int(11) NOT NULL AUTO_INCREMENT,  `name` varchar(45) NOT NULL,  PRIMARY KEY (`id`,`name`)) ENGINE=InnoDB AUTO_INCREMENT=3 DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_0900_ai_ci;#插入数据INSERT INTO `springboot-demo`.`test_sys` (`id`, `name`) VALUES ('1‘, 'test1');INSERT INTO `springboot-demo`.`test_sys` (`id`, `name`) VALUES ('2‘, 'test2');INSERT INTO `springboot-demo`.`test_sys` (`id`, `name`) VALUES ('3‘, 'test3');
  1. generator自动生成bean，dao，mapper，generator配置内容如下
<!DOCTYPE generatorConfiguration        PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN"        "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd"><generatorConfiguration>    <context id="Mysql" targetRuntime="MyBatis3Simple" defaultModelType="flat">        <property name="javaFileEncoding" value="UTF-8"/>        <property name="useMapperCommentGenerator" value="true"/>        <plugin type="tk.mybatis.mapper.generator.MapperPlugin"><!--            定义自己集成的baseMapper--><!--            <property name="mappers" value="tk.mybatis.mapper.common.Mapper"/>-->            <property name="mappers" value="com.cxt.demo.tk.MyBaseMapper"/>            <property name="caseSensitive" value="true"/>            <property name="forceAnnotation" value="false"/>            <property name="lombok"  value="Data"/>            <property name="swagger"  value="true"/>            <!--<property name="needsData"  value="true"/>-->        </plugin>        <!--tk-->        <jdbcConnection driverClass="com.mysql.cj.jdbc.Driver"                        connectionURL="jdbc:mysql://localhost:3306/springboot-demo?serverTimezone=UTC"                        userId="root"                        password="root">        </jdbcConnection>        <javaModelGenerator targetPackage="com.cxt.demo.bean"                            targetProject="src/main/java"/>        <sqlMapGenerator targetPackage="mapper"                         targetProject="src/main/resources"/>        <javaClientGenerator targetPackage="com.cxt.demo.dao"                             targetProject="src/main/java"                             type="XMLMAPPER"/>        <table tableName="test_sys"><generatedKey column="id" sqlStatement="JDBC"/></table>    </context></generatorConfiguration>
  1. 点击maven命令执行生成相对应的bean，dao，mapper


或者使用maven命令

mybatis-generator:generate –e
  1. 创建HelloController
package com.cxt.demo.controller;import com.cxt.demo.service.HelloService;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.stereotype.Repository;import org.springframework.web.bind.annotation.RequestMapping;import org.springframework.web.bind.annotation.RestController;/** * @author liBai * @Classname HelloController * @Description TODO * @Date 2019-06-02 10:49 */@RestController@RequestMapping("/test")public class HelloController {    @Autowired    private HelloService helloService;    @RequestMapping("/hello")    public String hello(){        return helloService.sayHello();    }}
  1. 创建HelloService
package com.cxt.demo.service;/** * @author liBai * @Classname HelloService * @Description TODO * @Date 2019-06-02 10:49 */public interface HelloService {    String sayHello();}
  1. 创建HelloServiceImpl实现
package com.cxt.demo.service.impl;import com.cxt.demo.bean.TestSys;import com.cxt.demo.dao.TestSysMapper;import com.cxt.demo.service.HelloService;import lombok.extern.slf4j.Slf4j;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.stereotype.Service;/** * @author liBai * @Classname HelloServiceImpl * @Description TODO * @Date 2019-06-02 10:50 */@Service@Slf4jpublic class HelloServiceImpl implements HelloService {    @Autowired    private TestSysMapper testSysMapper;    @Override    public String sayHello() {        TestSys testSys = testSysMapper.selectByPrimaryKey("1");        log.debug("testSys  =  [{}]",testSys.toString());        return testSys.getName();    }}
  1. 浏览器测试，url中输入 http://localhost:8081/test/hello 显示

  1. 到此为止，springboot整合通用mapper，使用mysql的demo就结束了，后续整合请关注后续博客
  2. 源码地址 https://github.com/TianPuJun/...