Spring Boot：如何優雅的使用 Mybatis

mybatis-spring-boot-starter

官方說明：MyBatis Spring-Boot-Starter will help you use MyBatis with Spring Boot
其實就是 Mybatis 看 Spring Boot 這麼火熱也開發出一套解決方案來湊湊熱鬧，但這一湊確實解決了不少問題，使用起來確實順暢了許多。mybatis-spring-boot-starter主要有兩種解決方案，一種是使用註解解決一切問題，一種是簡化後的老傳統。

固然任何模式都須要首先引入mybatis-spring-boot-starter的 Pom 文件，如今最新版本是 2.0.0

<dependency>
    <groupId>org.mybatis.spring.boot</groupId> <artifactId>mybatis-spring-boot-starter</artifactId> <version>2.0.0</version> </dependency> 

好了下來分別介紹兩種開發模式

無配置文件註解版

就是一切使用註解搞定。

1 添加相關 Maven 文件

<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>2.0.0</version> </dependency> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> </dependency> </dependencies> 

完整的 Pom 包這裏就不貼了，你們直接看源碼

二、application.properties 添加相關配置

mybatis.type-aliases-package=com.neo.model spring.datasource.url=jdbc:mysql://localhost:3306/test?serverTimezone=UTC&useUnicode=true&characterEncoding=utf-8&useSSL=true spring.datasource.username=root spring.datasource.password=root spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver 

Spring Boot 會自動加載 spring.datasource.* 相關配置，數據源就會自動注入到 sqlSessionFactory 中，sqlSessionFactory 會自動注入到 Mapper 中，對了，你一切都不用管了，直接拿起來使用就好了。

在啓動類中添加對 mapper 包掃描@MapperScan

@SpringBootApplication
@MapperScan("com.neo.mapper") public class MybatisAnnotationApplication { public static void main(String[] args) { SpringApplication.run(MybatisAnnotationApplication.class, args); } } 

或者直接在 Mapper 類上面添加註解@Mapper，建議使用上面那種，否則每一個 mapper 加個註解也挺麻煩的

三、開發 Mapper

第三步是最關鍵的一塊， Sql 生產都在這裏

public interface UserMapper { @Select("SELECT * FROM users") @Results({ @Result(property = "userSex", column = "user_sex", javaType = UserSexEnum.class), @Result(property = "nickName", column = "nick_name") }) List<UserEntity> getAll(); @Select("SELECT * FROM users WHERE id = #{id}") @Results({ @Result(property = "userSex", column = "user_sex", javaType = UserSexEnum.class), @Result(property = "nickName", column = "nick_name") }) UserEntity getOne(Long id); @Insert("INSERT INTO users(userName,passWord,user_sex) VALUES(#{userName}, #{passWord}, #{userSex})") void insert(UserEntity user); @Update("UPDATE users SET userName=#{userName},nick_name=#{nickName} WHERE id =#{id}") void update(UserEntity user); @Delete("DELETE FROM users WHERE id =#{id}") void delete(Long id); } 

爲了更接近生產我特意將 user_sex、nick_name 兩個屬性在數據庫加了下劃線和實體類屬性名不一致，另外 user_sex 使用了枚舉

• @Select 是查詢類的註解，全部的查詢均使用這個
• @Result 修飾返回的結果集，關聯實體類屬性和數據庫字段一一對應，若是實體類屬性和數據庫屬性名保持一致，就不須要這個屬性來修飾。
• @Insert 插入數據庫使用，直接傳入實體類會自動解析屬性到對應的值
• @Update 負責修改，也能夠直接傳入對象
• @delete 負責刪除

瞭解更多屬性參考這裏

注意，使用#符號和$符號的不一樣：

// This example creates a prepared statement, something like select * from teacher where name = ?;
@Select("Select * from teacher where name = #{name}")
Teacher selectTeachForGivenName(@Param("name") String name);

// This example creates n inlined statement, something like select * from teacher where name = 'someName';
@Select("Select * from teacher where name = '${name}'")
Teacher selectTeachForGivenName(@Param("name") String name);

四、使用

上面三步就基本完成了相關 Mapper 層開發，使用的時候看成普通的類注入進入就能夠了

@RunWith(SpringRunner.class) @SpringBootTest public class UserMapperTest { @Autowired private UserMapper userMapper; @Test public void testInsert() throws Exception { userMapper.insert(new User("aa1", "a123456", UserSexEnum.MAN)); userMapper.insert(new User("bb1", "b123456", UserSexEnum.WOMAN)); userMapper.insert(new User("cc1", "b123456", UserSexEnum.WOMAN)); Assert.assertEquals(3, userMapper.getAll().size()); } @Test public void testQuery() throws Exception { List<User> users = userMapper.getAll(); System.out.println(users.toString()); } @Test public void testUpdate() throws Exception { User user = userMapper.getOne(30l); System.out.println(user.toString()); user.setNickName("neo"); userMapper.update(user); Assert.assertTrue(("neo".equals(userMapper.getOne(30l).getNickName()))); } } 

源碼中 Controller 層有完整的增刪改查，這裏就不貼了

極簡 xml 版本

極簡 xml 版本保持映射文件的老傳統，接口層只須要定義空方法，系統會自動根據方法名在映射文件中找對應的 Sql .

一、配置

pom 文件和上個版本同樣，只是application.properties新增如下配置

mybatis.config-location=classpath:mybatis/mybatis-config.xml mybatis.mapper-locations=classpath:mybatis/mapper/*.xml 

指定了 Mybatis 基礎配置文件和實體類映射文件的地址

mybatis-config.xml 配置

<configuration>
    <typeAliases> <typeAlias alias="Integer" type="java.lang.Integer" /> <typeAlias alias="Long" type="java.lang.Long" /> <typeAlias alias="HashMap" type="java.util.HashMap" /> <typeAlias alias="LinkedHashMap" type="java.util.LinkedHashMap" /> <typeAlias alias="ArrayList" type="java.util.ArrayList" /> <typeAlias alias="LinkedList" type="java.util.LinkedList" /> </typeAliases> </configuration> 

這裏也能夠添加一些 Mybatis 基礎的配置

二、添加 User 的映射文件

<mapper namespace="com.neo.mapper.UserMapper" > <resultMap id="BaseResultMap" type="com.neo.entity.UserEntity" > <id column="id" property="id" jdbcType="BIGINT" /> <result column="userName" property="userName" jdbcType="VARCHAR" /> <result column="passWord" property="passWord" jdbcType="VARCHAR" /> <result column="user_sex" property="userSex" javaType="com.neo.enums.UserSexEnum"/> <result column="nick_name" property="nickName" jdbcType="VARCHAR" /> </resultMap> <sql id="Base_Column_List" > id, userName, passWord, user_sex, nick_name </sql> <select id="getAll" resultMap="BaseResultMap" > SELECT <include refid="Base_Column_List" /> FROM users </select> <select id="getOne" parameterType="java.lang.Long" resultMap="BaseResultMap" > SELECT <include refid="Base_Column_List" /> FROM users WHERE id = #{id} </select> <insert id="insert" parameterType="com.neo.entity.UserEntity" > INSERT INTO users (userName,passWord,user_sex) VALUES (#{userName}, #{passWord}, #{userSex}) </insert> <update id="update" parameterType="com.neo.entity.UserEntity" > UPDATE users SET <if test="userName != null">userName = #{userName},</if> <if test="passWord != null">passWord = #{passWord},</if> nick_name = #{nickName} WHERE id = #{id} </update> <delete id="delete" parameterType="java.lang.Long" > DELETE FROM users WHERE id =#{id} </delete> </mapper> 

其實就是把上個版本中 Mapper 的 Sql 搬到了這裏的 xml 中了

三、編寫 Mapper 層的代碼

public interface UserMapper { List<UserEntity> getAll(); UserEntity getOne(Long id); void insert(UserEntity user); void update(UserEntity user); void delete(Long id); } 

對比上一步，這裏只須要定義接口方法

四、使用

使用和上個版本沒有任何區別，你們就看文章對應的示例代碼吧

如何選擇

兩種模式各有特色，註解版適合簡單快速的模式，其實像如今流行的這種微服務模式，一個微服務就會對應一個自已的數據庫，多表鏈接查詢的需求會大大的下降，會愈來愈適合這種模式。

老傳統模式比適合大型項目，能夠靈活的動態生成 Sql ，方便調整 Sql ，也有痛痛快快，洋洋灑灑的寫 Sql 的感受。

文章內容已經升級到 Spring Boot 2.x