SpringBoot 優(yōu)雅使用 Mybatis 的幾種姿勢(shì)！
ORM 框架的本質(zhì)是簡(jiǎn)化編程中操作數(shù)據(jù)庫(kù)的編碼，發(fā)展到現(xiàn)在基本上就剩兩家了，一個(gè)是宣稱可以不用寫一句 Sql 的 Hibernate，一個(gè)是可以靈活調(diào)試動(dòng)態(tài) Sql 的 Mybatis ,兩者各有特點(diǎn)，在企業(yè)級(jí)系統(tǒng)開(kāi)發(fā)中可以根據(jù)需求靈活使用。發(fā)現(xiàn)一個(gè)有趣的現(xiàn)象：傳統(tǒng)企業(yè)大都喜歡使用 Hibernate ,互聯(lián)網(wǎng)行業(yè)通常使用 Mybatis 。
Mybatis 初期使用比較麻煩，需要各種配置文件、實(shí)體類、Dao 層映射關(guān)聯(lián)、還有一大推其它配置。當(dāng)然 Mybatis 也發(fā)現(xiàn)了這種弊端，初期開(kāi)發(fā)了generator可以根據(jù)表結(jié)果自動(dòng)生產(chǎn)實(shí)體類、配置文件和 Dao 層代碼，可以減輕一部分開(kāi)發(fā)量；后期也進(jìn)行了大量的優(yōu)化可以使用注解了，自動(dòng)管理 Dao 層和配置文件等，發(fā)展到最頂端就是今天要講的這種模式了， mybatis-spring-boot-starter就是 Spring Boot+ Mybatis 可以完全注解不用配置文件，也可以簡(jiǎn)單配置輕松上手。
現(xiàn)在想想 Spring Boot 就是牛逼呀，任何東西只要關(guān)聯(lián)到 Spring Boot 都是化繁為簡(jiǎn)。
mybatis-spring-boot-starter主要有兩種解決方案，一種是使用注解解決一切問(wèn)題，一種是簡(jiǎn)化后的老傳統(tǒng)。
當(dāng)然任何模式都需要首先引入 mybatis-spring-boot-starter的 Pom 文件。
<dependency>
<groupId>org.mybatis.spring.boot</groupId>
<artifactId>mybatis-spring-boot-starter</artifactId>
<version>2.0.0</version>
</dependency>好了下來(lái)分別介紹兩種開(kāi)發(fā)模式。
無(wú)配置文件注解版
就是一切使用注解搞定。
1、添加相關(guān) 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 包這里就不貼了，大家直接看源碼。
2、添加相關(guān)配置
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.DriverSpring Boot 會(huì)自動(dòng)加載 spring.datasource.* 相關(guān)配置，數(shù)據(jù)源就會(huì)自動(dòng)注入到 sqlSessionFactory 中，sqlSessionFactory 會(huì)自動(dòng)注入到 Mapper 中，對(duì)了，你一切都不用管了，直接拿起來(lái)使用就行了。
在啟動(dòng)類中添加對(duì) mapper 包掃描@MapperScan
@SpringBootApplication
@MapperScan("com.neo.mapper")
public class MybatisAnnotationApplication {
public static void main(String[] args) {
SpringApplication.run(MybatisAnnotationApplication.class, args);
}
}或者直接在 Mapper 類上面添加注解@Mapper，建議使用上面那種，不然每個(gè) mapper 加個(gè)注解也挺麻煩的。
3、開(kāi)發(fā) Mapper
第三步是最關(guān)鍵的一塊， Sql 生產(chǎn)都在這里。
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);
}為了更接近生產(chǎn)我特地將usersex、nickname兩個(gè)屬性在數(shù)據(jù)庫(kù)加了下劃線和實(shí)體類屬性名不一致，另外user_sex使用了枚舉。
- @Select 是查詢類的注解，所有的查詢均使用這個(gè)
- @Result 修飾返回的結(jié)果集，關(guān)聯(lián)實(shí)體類屬性和數(shù)據(jù)庫(kù)字段一一對(duì)應(yīng)，如果實(shí)體類屬性和數(shù)據(jù)庫(kù)屬性名保持一致，就不需要這個(gè)屬性來(lái)修飾。
- @Insert 插入數(shù)據(jù)庫(kù)使用，直接傳入實(shí)體類會(huì)自動(dòng)解析屬性到對(duì)應(yīng)的值
- @Update 負(fù)責(zé)修改，也可以直接傳入對(duì)象
- @delete 負(fù)責(zé)刪除
注意，使用#符號(hào)和$符號(hào)的不同：
// 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、使用
上面三步就基本完成了相關(guān) Mapper 層開(kāi)發(fā)，使用的時(shí)候當(dāng)作普通的類注入進(jìn)入就可以了。
@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 層有完整的增刪改查，這里就不貼了。
極簡(jiǎn) xml 版本
極簡(jiǎn) xml 版本保持映射文件的老傳統(tǒng)，接口層只需要定義空方法，系統(tǒng)會(huì)自動(dòng)根據(jù)方法名在映射文件中找對(duì)應(yīng)的 Sql。
1、配置
pom 文件和上個(gè)版本一樣，只是 application.properties新增以下配置。
mybatis.config-location=classpath:mybatis/mybatis-config.xml
mybatis.mapper-locations=classpath:mybatis/mapper/*.xml指定了 Mybatis 基礎(chǔ)配置文件和實(shí)體類映射文件的地址
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 基礎(chǔ)的配置
<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>其實(shí)就是把上個(gè)版本中 Mapper 的 Sql 搬到了這里的 xml 中了
3、編寫 Mapper 層的代碼
public interface UserMapper {
List<UserEntity> getAll();
UserEntity getOne(Long id);
void insert(UserEntity user);
void update(UserEntity user);
void delete(Long id);
}對(duì)比上一步，這里只需要定義接口方法
4、使用
使用和上個(gè)版本沒(méi)有任何區(qū)別。
如何選擇
兩種模式各有特點(diǎn)，注解版適合簡(jiǎn)單快速的模式，其實(shí)像現(xiàn)在流行的這種微服務(wù)模式，一個(gè)微服務(wù)就會(huì)對(duì)應(yīng)一個(gè)自已的數(shù)據(jù)庫(kù)，多表連接查詢的需求會(huì)大大的降低，會(huì)越來(lái)越適合這種模式。
老傳統(tǒng)模式比適合大型項(xiàng)目，可以靈活的動(dòng)態(tài)生成 Sql ，方便調(diào)整 Sql ，也有痛痛快快，洋洋灑灑的寫 Sql 的感覺(jué)。
