Spring Boot學習筆記(二二) - 與Mybatis整合
阿新 • • 發佈：2018-12-14
Mybatis整合
Spring Boot中的JPA部分預設是使用的hibernate，而如果想使用Mybatis的話就需要自己做一些配置。使用方式有兩種，第一種是Mybatis官方提供的 mybatis-spring-boot-starter ，第二種是類似 mybatis-spring的方式，需要自己寫一些程式碼。但是可以更方便地控制Mybatis的各項配置。
mybatis-spring-boot-starter
這種方式只需要在application.properties中配置相關的Mybatis屬性就可以了。資料來源使用的是Spring Boot預設的資料來源
mybatis.mapperLocations: mapper配置檔案的路徑，支援萬用字元方式
mybatis.typeAliasesPackage: 用來掃描Entity的包
mybatis.config：mybatis-config.xml配置檔案的路徑
mybatis.typeHandlersPackage：掃描typeHandlers的包
mybatis.checkConfigLocation：檢查配置檔案是否存在
mybatis.executorType：設定執行模式（SIMPLE, REUSE, BATCH），預設為SIMPLEmybatis-spring方式
這種方式和平常的用法比較接近。需要新增mybatis依賴和mybatis-spring依賴。然後建立一個MyBatisConfig
package com.freud.test.springboot; import javax.sql.DataSource; import org.apache.ibatis.session.SqlSessionFactory; import org.mybatis.spring.SqlSessionFactoryBean; import org.mybatis.spring.SqlSessionTemplate; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; import org.springframework.core.io.support.PathMatchingResourcePatternResolver; import org.springframework.core.io.support.ResourcePatternResolver; import org.springframework.jdbc.datasource.DataSourceTransactionManager; import org.springframework.transaction.PlatformTransactionManager; import org.springframework.transaction.annotation.EnableTransactionManagement; import org.springframework.transaction.annotation.TransactionManagementConfigurer; /** * MyBatis基礎配置 * * @author Freud */ @Configuration @EnableTransactionManagement public class MybatisConfig implements TransactionManagementConfigurer { @Autowired private DataSource dataSource; @Bean(name = "sqlSessionFactory") public SqlSessionFactory sqlSessionFactoryBean() { SqlSessionFactoryBean bean = new SqlSessionFactoryBean(); bean.setDataSource(dataSource); bean.setTypeAliasesPackage("com.freud.test.springboot"); // 新增XML目錄 ResourcePatternResolver resolver = new PathMatchingResourcePatternResolver(); try { bean.setMapperLocations(resolver.getResources("classpath:mapper/*.xml")); return bean.getObject(); } catch (Exception e) { e.printStackTrace(); throw new RuntimeException(e); } } @Bean public SqlSessionTemplate sqlSessionTemplate(SqlSessionFactory sqlSessionFactory) { return new SqlSessionTemplate(sqlSessionFactory); } // * 因為添加了spring-boot-starter-
* jdbc依賴，會觸發DataSourceTransactionManagerAutoConfiguration這個自動化配置類
* ，自動構造事務管理器，所以若只有一個數據源可以不必進行下面的配置@Bean public PlatformTransactionManager annotationDrivenTransactionManager() { return new DataSourceTransactionManager(dataSource); } }上面程式碼建立了一個SqlSessionFactory和一個SqlSessionTemplate，為了支援註解事務，增加了@EnableTransactionManagement註解，並且反回了一個PlatformTransactionManagerBean。
新增一個MyBatisMapperScannerConfig.java類，把mapper掃描單獨放在這裡配置（或者在Application 新增@MapperScan註解）
如果想要掃描MyBatis的Mapper介面, 就需要配置MapperScannerConfigurer。
package com.freud.test.springboot; import org.mybatis.spring.mapper.MapperScannerConfigurer; import org.springframework.boot.autoconfigure.AutoConfigureAfter; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; /** * MyBatis掃描介面 * * @author Freud */ @Configuration // 注意，由於MapperScannerConfigurer執行的比較早，所以必須有下面的註解 @AutoConfigureAfter(MybatisConfig.class) public class MyBatisMapperScannerConfig { @Bean public MapperScannerConfigurer mapperScannerConfigurer() { MapperScannerConfigurer mapperScannerConfigurer = new MapperScannerConfigurer(); mapperScannerConfigurer.setSqlSessionFactoryBeanName("sqlSessionFactory"); mapperScannerConfigurer.setBasePackage("com.freud.test.springboot.mapper"); return mapperScannerConfigurer; } }
實驗
本實驗使用mybatis-spring-boot-starter方式。
建立一個Maven專案
pom.xml
<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> <groupId>com.freud.test</groupId> <artifactId>spring-boot-22</artifactId> <version>0.0.1-SNAPSHOT</version> <packaging>jar</packaging> <name>spring-boot-22</name> <url>http://maven.apache.org</url> <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> </properties> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-web</artifactId> </dependency> <dependency> <groupId>org.mybatis.spring.boot</groupId> <artifactId>mybatis-spring-boot-starter</artifactId> <version>1.0.0</version> </dependency> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-starter-jdbc</artifactId> </dependency> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> </dependency> </dependencies> <build> <plugins> <plugin> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-maven-plugin</artifactId> </plugin> </plugins> </build> <dependencyManagement> <dependencies> <dependency> <groupId>org.springframework.boot</groupId> <artifactId>spring-boot-dependencies</artifactId> <version>1.5.4.RELEASE</version> <type>pom</type> <scope>import</scope> </dependency> </dependencies> </dependencyManagement> </project>application.yml
spring:
application:
name: test-22 jpa: generate-ddl: false show-sql: true hibernate: ddl-auto: none datasource: platform: MYSQL continue-on-error: false driver-class-name: com.mysql.jdbc.Driver url: jdbc:mysql://localhost:3306/test?useSSL=false username: root password: root schema: classpath:schema.sql data: classpath:data.sql server: port: 9090 mybatis: mapper-locations: classpath:mapper/*.xml type-aliases-package: com.freud.test.springbootschema.sql
DROP TABLE IF EXISTS `user`; CREATE TABLE `user` ( `id` int(20) NOT NULL AUTO_INCREMENT, `name` varchar(50) NOT NULL, `age` int(10) NOT NULL, PRIMARY KEY (`id`) ) ENGINE=InnoDB DEFAULT CHARSET=utf8; DELETE FROM `user`;data.sql
insert into user(id, name, age) values(1,'Freud1',29); insert into user(id, name, age) values(2,'Freud2',29); insert into user(id, name, age) values(3,'Freud3',29); insert into user(id, name, age) values(4,'Freud4',29); insert into user(id, name, age) values(5,'Freud5',29);UserMapper.xml
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
PUBLIC "-//ibatis.apache.org//DTD Mapper 3.0//EN"
"http://ibatis.apache.org/dtd/ibatis-3-mapper.dtd">
<mapper namespace="com.freud.test.springboot.mapper.UserMapper"> <resultMap id="user" type="com.freud.test.springboot.bean.User"> <id property="id" jdbcType="INTEGER" column="ID"/> <result property="name" jdbcType="VARCHAR" column="NAME"/> <result property="age" jdbcType="INTEGER" column="AGE"/> </resultMap> <select id="getById" resultMap="user"> SELECT ID, NAME, AGE FROM USER WHERE ID = #{id} </select> <insert id="insert"> INSERT INTO USER ( NAME, AGE ) VALUES ( #{name}, #{age} ) </insert> <delete id="delete"> DELETE FROM USER WHERE ID = #{id} </delete> </mapper>User.java
package com.freud.test.springboot.bean; /** * @author Freud */ public class User { private long id; private String name; private int age; public long getId() { return id; } public void setId(long id) { this.id = id; } public String getName() { return name; } public void setName(String name) { this.name = name; } public int getAge() { return age; } public void setAge(int age) { this.age = age; } }UserController.java
package com.freud.test.springboot.controller; import java.util.List; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RequestMapping; import org.springframework.web.bind.annotation.RequestParam; import org.springframework.web.bind.annotation.RestController; import com.freud.test.springboot.bean.User; import com.freud.test.springboot.mapper.UserMapper; /** * @author Freud */ @RestController @RequestMapping("/user") public class UserController { public static final String RESULT_SUCCESS = "success"; public static final String RESULT_FAILED = "failed"; @Autowired private UserMapper userMapper; @GetMapping("/all") public List<User> all() { return userMapper.getAll(); } @GetMapping("/find") public User find(@RequestParam("id") long id) { return userMapper.getById(id); } @GetMapping("/save") public String save(User user) { try { userMapper.insert(user); return RESULT_SUCCESS; } catch (Exception e) { return RESULT_FAILED; } } @GetMapping("/delete") public String delete(@RequestParam("id") long id) { try { userMapper.delete(id); return RESULT_SUCCESS; } catch (Exception e) { return RESULT_FAILED; } } }UserMapper.java
package com.freud.test.springboot.mapper; import java.util.List; import org.apache.ibatis.annotations.Param; import org.apache.ibatis.annotations.Select; import com.freud.test.springboot.bean.User; /** * @author Freud */ public interface UserMapper { @Select("SELECT * FROM USER") public List<User> getAll(); public User getById(@Param("id") long id); public void insert(User user); public void delete(@Param("id") long id); }App.java
package com.freud.test.springboot; import org.springframework.boot.SpringApplication; import org.springframework.boot.autoconfigure.SpringBootApplication; /** * @author Freud */ @SpringBootApplication public class App { public static void main(String[] args) { SpringApplication.run(App.class, args); } }專案結構
執行及結果
訪問http://localhost:9090/user/all，檢視所有的使用者列表：
通過瀏覽器的Get請求建立一個新的使用者http://localhost:9090/user/save?name=kang&age=30
重新訪問http://localhost:9090/user/all，檢視所有的使用者列表：
通過ID查詢某個使用者資訊http://localhost:9090/user/find?id=2：
通過ID刪除某個使用者資訊http://localhost:9090/user/delete?id=1
重新訪問http://localhost:9090/user/all，檢視所有的使用者列表：
