展開被 SpringBoot 玩的日子 《 六 》 整合 Mybatis
上次整合了JPA ,但是很多人覺得JPA 並不是那麼好用,這都是習慣問題,我本人也比較習慣Mybatis ,所以,今天就整合一下Mybatis,到網上找了一下關於spring boot和mybatis組合的相關資料,各種各樣的形式都有,看的人心累,結合了mybatis的官方demo和文件終於找到了最簡的兩種模式,花了一天時間總結後分享出來。接下來再搞一個萬能的 Result 類來接受多表關聯查詢的問題。
orm框架的本質是簡化程式設計中操作資料庫的編碼,發展到現在基本上就剩兩家了,一個是宣稱可以不用寫一句SQL的hibernate,一個是可以靈活除錯動態sql的mybatis,兩者各有特點,在企業級系統開發中可以根據需求靈活使用。發現一個有趣的現象:傳統企業大都喜歡使用hibernate,網際網路行業通常使用mybatis。
hibernate特點就是所有的sql都用Java程式碼來生成,不用跳出程式去寫(看)sql,有著程式設計的完整性,發展到最頂端就是spring data jpa這種模式了,基本上根據方法名就可以生成對應的sql了,有不太瞭解的可以看我的上篇文章springboot(五):spring data jpa的使用。
mybatis初期使用比較麻煩,需要各種配置檔案、實體類、dao層對映關聯、還有一大推其它配置。當然mybatis也發現了這種弊端,初期開發了generator可以根據表結果自動生產實體類、配置檔案和dao層程式碼,可以減輕一部分開發量;後期也進行了大量的優化可以使用註解了,自動管理dao層和配置檔案等,發展到最頂端就是今天要講的這種模式了,mybatis-spring-boot-starter就是springboot+mybatis可以完全註解不用配置檔案,也可以簡單配置輕鬆上手。
現在想想spring boot 就是牛逼呀,任何東西只要關聯到spring boot都是化繁為簡。
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檔案,現在最新版本是1.1.1。
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>1.1.1</version>
</dependency>
好了下來分別介紹兩種開發模式。
無配置檔案註解版
就是一切使用註解搞定。
1 新增相關maven檔案(按照之前的教程,只要新增 Mybatis的jar 就可以了)
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>1.1.1</version>
</dependency>
2、application.properties 新增相關配置
# 整合 Mybatis 實體包名
mybatis.type-aliases-package=com.xjb.springBootDemo.domain
springboot會自動載入spring.datasource.*相關配置,資料來源就會自動注入到sqlSessionFactory中,sqlSessionFactory會自動注入到Mapper中,對了你一切都不用管了,直接拿起來使用就行了。
在啟動類中新增對mapper包掃描@MapperScan。
@SpringBootApplication
@MapperScan("com.neo.mapper")
public class Application {
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
}
}
或者直接在Mapper類上面添加註解@Mapper,建議使用上面那種,不然每個mapper加個註解也挺麻煩的。
3、開發Mapper
第三步是最關鍵的一塊,sql生產都在這裡。
/**
* Mybatis 註解的方式
*/
public interface UserMapper {
/**
* 獲取全部使用者
* @return
*/
@Select("select * from user")
@Results({
@Result(property = "userName", column = "user_name"),
@Result(property = "nickName", column = "nick_name"),
@Result(property = "regTime", column = "reg_time")
})
List<User> getAll();
@Select("SELECT * FROM user WHERE id = #{id}")
@Results({
@Result(property = "userName", column = "user_name"),
@Result(property = "nickName", column = "nick_name"),
@Result(property = "regTime", column = "reg_time")
})
User getOne(Long id);
@Insert("INSERT INTO user(user_name,password,nick_name) VALUES(#{userName}, #{password}, #{nickName})")
void insert(User user);
@Update("UPDATE user(user_name,nick_name) SET user_name=#{userName},nick_name=#{nickName} WHERE id =#{id}")
void update(User user);
@Delete("DELETE FROM user WHERE id =#{id}")
void delete(Long id);
}
-
@Select 是查詢類的註解,所有的查詢均使用這個
-
@Result 修飾返回的結果集,關聯實體類屬性和資料庫欄位一一對應,如果實體類屬性和資料庫屬性名保持一致,就不需要這個屬性來修飾。
-
@Insert 插入資料庫使用,直接傳入實體類會自動解析屬性到對應的值
-
@Update 負責修改,也可以直接傳入物件
-
@delete 負責刪除
瞭解更多屬性參考這裡。
http://www.mybatis.org/mybatis-3/zh/java-api.html
注意,使用#符號和$符號的不同:
// 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);
4、使用
上面三步就基本完成了相關dao層開發,使用的時候當作普通的類注入進入就可以了。
@RunWith(SpringRunner.class)
@SpringBootTest
public class SpringBootDemoApplicationTests {
@Autowired
private UserDao userDao;
@Autowired
private UserMapper userMapper;
@Test
public void testUser () {
// 註解方式 Mybatis
List<User> userList = userMapper.getAll();
for (User user : userList) {
System.out.println(user.toString());
}
// JPA 方式
System.out.println("-------------------------------------------------------");
List<User> users = userDao.findByUser();
for (User user : users) {
System.out.println(user.toString());
}
// 註解方式 Mybatis
System.out.println("-------------------------------------------------------");
User user = userMapper.getOne(60l);
if (user == null) {
System.out.println("**************");
} else {
System.out.println(user.toString());
}
}
}
原始碼中controler層有完整的增刪改查,這裡就不貼了。
極簡xml版本
極簡xml版本保持對映檔案的老傳統,優化主要體現在不需要實現dao的是實現層,系統會自動根據方法名在對映檔案中找對應的sql。
1、配置
pom檔案和上個版本一樣,只是application.properties新增以下配置。
# Mybatis 使用XML 的形式
mybatis.config-locations=classpath:/mybatis-config.xml
mybatis.mapper-locations=classpath:com/xjb/springBootDemo/domain/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基礎的配置。
2、新增User的對映檔案
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.xjb.springBootDemo.domain.mapper.UserMapperXml" >
<resultMap id="BaseResultMap" type="com.xjb.springBootDemo.domain.User" >
<id column="id" property="id" jdbcType="BIGINT" />
<result column="email" property="email" jdbcType="VARCHAR" />
<result column="nick_name" property="nickName" jdbcType="VARCHAR" />
<result column="password" property="password" jdbcType="VARCHAR"/>
<result column="reg_time" property="regTime" jdbcType="VARCHAR" />
<result column="user_name" property="userName" jdbcType="VARCHAR" />
</resultMap>
<sql id="Base_Column_List" >
id, email, nick_name, password, reg_time, user_name
</sql>
<select id="getAll" resultMap="BaseResultMap" >
SELECT
<include refid="Base_Column_List" />
FROM user
</select>
<select id="getOne" parameterType="java.lang.Long" resultMap="BaseResultMap" >
SELECT
<include refid="Base_Column_List" />
FROM user
WHERE id = #{id}
</select>
<insert id="insert" parameterType="com.xjb.springBootDemo.domain.User" >
INSERT INTO
user
(user_name,password,nick_name)
VALUES
(#{userName}, #{passWord}, #{userSex})
</insert>
<update id="update" parameterType="com.xjb.springBootDemo.domain.User" >
UPDATE
user
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
user
WHERE
id =#{id}
</delete>
</mapper>
其實就是把上個版本中mapper的sql搬到了這裡的xml中了。
3、編寫Dao層的程式碼
/**
* Mybatis xml 方式
*/
public interface UserMapperXml {
List<User> getAll();
User getOne(Long id);
void insert(User user);
void update(User user);
void delete(Long id);
}
對比上一步這裡全部只剩了介面方法。
4、使用
使用和上個版本沒有任何區別,大家就看程式碼吧。
如何選擇
兩種模式各有特點,註解版適合簡單快速的模式,其實像現在流行的這種微服務模式,一個微服務就會對應一個自已的資料庫,多表連線查詢的需求會大大的降低,會越來越適合這種模式。
老傳統模式比適合大型專案,可以靈活的動態生成SQL,方便調整SQL,也有痛痛快快,洋洋灑灑的寫SQL的感覺。
示例程式碼:
https://github.com/ityouknow/spring-boot-examples