springboot搭建後臺框架 (一)整合tkMapper
阿新 • • 發佈:2019-06-05
springboot整合tkMapper
想著每次搭建新專案時框架都要從新搭建,基本常用的也就哪幾種,現在就來搭建一種常用的springboot後臺框架,以後新開小專案可以直接拿來使用
- 專案整體結構圖
2.新建springboot空白專案,選中web依賴(略,也可以完全根據本人程式碼操作)
3.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>
- 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.StdOutImpl mapper: 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
- 新建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 */ @Repository public interface MyBaseMapper<T> extends Mapper<T>, MySqlMapper<T> , ExampleMapper<T> { }
- 啟動類新增掃描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);
}
}
- 新增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
*/
@SpringBootConfiguration
public 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();
}
}
- 資料庫建立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');
- 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>
- 點選maven命令執行生成相對應的bean,dao,mapper 或者使用maven命令
mybatis-generator:generate –e
- 建立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();
}
}
- 建立HelloService
package com.cxt.demo.service;
/**
* @author liBai
* @Classname HelloService
* @Description TODO
* @Date 2019-06-02 10:49
*/
public interface HelloService {
String sayHello();
}
- 建立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
@Slf4j
public 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();
}
}
- 瀏覽器測試,url中輸入 http://localhost:8081/test/hello 顯示
- 到此為止,springboot整合通用mapper,使用mysql的demo就結束了,後續整合請關注後續部落格
- 原始碼地址 https://github.com/TianPuJun/springboo