作者：Bobby0322；
鏈接：https://www.jianshu.com/p/3ba4f992e655

這兩天啓動了一個新項目因爲項目組成員一直都使用的是mybatis，雖然個人比較喜歡jpa這種極簡的模式，但是爲了項目保持統一性技術選型還是定了 mybatis。到網上找了一下關於spring boot和mybatis組合的相關資料，各種各樣的形式都有，看的人心累，結合了mybatis的官方demo和文檔終於找到了最簡的兩種模式，花了一天時間總結後分享出來。

orm框架的本質是簡化編程中操作數據庫的編碼，發展到現在基本上就剩兩家了，一個是宣稱可以不用寫一句SQL的hibernate，一個是可以靈活調試動態sql的mybatis,兩者各有特點，在企業級系統開發中可以根據需求靈活使用。發現一個有趣的現象：傳統企業大都喜歡使用hibernate,互聯網行業通常使用mybatis。

hibernate特點就是所有的sql都用Java代碼來生成，不用跳出程序去寫（看）sql，有着編程的完整性，發展到最頂端就是spring data jpa這種模式了，基本上根據方法名就可以生成對應的sql了。

mybatis初期使用比較麻煩，需要各種配置文件、實體類、dao層映射關聯、還有一大推其它配置。當然mybatis也發現了這種弊端，初期開發了generator可以根據表結果自動生產實體類、配置文件和dao層代碼，可以減輕一部分開發量；後期也進行了大量的優化可以使用註解了，自動管理dao層和配置文件等，發展到最頂端就是今天要講的這種模式了，mybatis-spring-boot-starter就是springboot+mybatis可以完全註解不用配置文件，也可以簡單配置輕鬆上手。

現在想想spring boot 就是牛逼呀，任何東西只要關聯到spring boot都是化繁爲簡。

其實就是myBatis看spring boot這麼火熱也開發出一套解決方案來湊湊熱鬧,但這一湊確實解決了很多問題，使用起來確實順暢了許多。mybatis-spring-boot-starter主要有兩種解決方案，一種是使用註解解決一切問題，一種是簡化後的老傳統。

1 無配置文件註解版

就是一切使用註解搞定。

1.1 項目依賴

引入連接mysql的必要依賴mysql-connector-java；
引入整合MyBatis的核心依賴mybatis-spring-boot-starter；
引入tk.mybatis 依賴，實現對實體類的增刪改查的代碼；
引入pagerhelper 依賴，實現分頁功能。




 org.mybatis.spring.boot
 mybatis-spring-boot-starter
 1.3.0



 mysql
 mysql-connector-java
 5.1.43



 tk.mybatis
 mapper-spring-boot-starter
 1.1.3



 com.github.pagehelper
 pagehelper-spring-boot-starter
 1.1.2

1.2 application.properties 添加相關配置

spring.datasource.url=jdbc:mysql://localhost:3306/tdf_db?characterEncoding=utf-8&serverTimezone=UTC&useSSL=false
spring.datasource.username=root
spring.datasource.password=123456
spring.datasource.driver-class-name=com.mysql.jdbc.Driver
#實體類掃描包
mybatis.type-aliases-package=com.pingkeke.springBoot.entity
#Mapper.xml文件掃描目錄
mybatis.mapper-locations=classpath:mapper/*.xml
#駝峯命名
mybatis.configuration.mapUnderscoreToCamelCase=true
#tkmapper 工具類
mapper.mappers=com.pingkeke.springBoot.util.MyMapper
mapper.not-empty=false
mapper.identity=MYSQL
pagehelper.helperDialect=mysql
pagehelper.reasonable=true
pagehelper.supportMethodsArguments=true
pagehelper.params=count=countSql

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

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

package com.pingkeke.springBoot;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
/**
 * 在啓動類中添加對mapper包掃描@MapperScan,Note by:CHENQP
 */
@SpringBootApplication
@MapperScan("com.pingkeke.springBoot.mapper")
public class Application {
 public static void main(String[] args) {
 SpringApplication.run(Application.class, args);
 }
}

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

1.4 開發Mapper

SET FOREIGN_KEY_CHECKS=0;
-- ----------------------------
-- Table structure for `users`
-- ----------------------------
DROP TABLE IF EXISTS `users`;
CREATE TABLE `users` (
 `id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT '主鍵id',
 `userName` varchar(32) DEFAULT NULL COMMENT '用戶名',
 `passWord` varchar(32) DEFAULT NULL COMMENT '密碼',
 `user_sex` varchar(32) DEFAULT NULL,
 `nick_name` varchar(32) DEFAULT NULL,
 PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=28 DEFAULT CHARSET=utf8;

entity

package com.pingkeke.springBoot.entity;
import com.pingkeke.springBoot.enums.UserSexEnum;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import lombok.experimental.Accessors;
/**
 * User.
 */
@Data
@NoArgsConstructor
@AllArgsConstructor
@Accessors(chain = true)
public class User {
 private Long id;
 private String userName;
 private String passWord;
 private UserSexEnum userSex;
 private String nickName;
}

是最關鍵的一塊，sql生產都在這裏；

package com.pingkeke.springBoot.mapper;
import com.pingkeke.springBoot.entity.UserEntity;
import com.pingkeke.springBoot.enums.UserSexEnum;
import org.apache.ibatis.annotations.*;
import java.util.List;
/**
 * UserMapper.
 * sql生產都在這裏
 *
 * 爲了更接近生產我特地將user_sex、nick_name兩個屬性在數據庫加了下劃線和實體類屬性名不一致，
 * 另外user_sex使用了枚舉
 *
 * @Select 是查詢類的註解，所有的查詢均使用這個
 @Result 修飾返回的結果集，關聯實體類屬性和數據庫字段一一對應，
 如果實體類屬性和數據庫屬性名保持一致，就不需要這個屬性來修飾。
 @Insert 插入數據庫使用，直接傳入實體類會自動解析屬性到對應的值
 @Update 負責修改，也可以直接傳入對象
 @delete 負責刪除
 */
public interface UserMapper {
 @Select("SELECT * FROM users")
 @Results({
 @Result(property = "userSex", column = "user_sex", javaType = UserSexEnum.class),
 @Result(property = "nickName", column = "nick_name")
 })
 List 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);
}

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

1.5 使用

上面三步就基本完成了相關dao層開發，使用的時候當作普通的類注入進入就可以了。

package com.pingkeke.springBoot.mapper;
import com.pingkeke.springBoot.entity.UserEntity;
import com.pingkeke.springBoot.enums.UserSexEnum;
import org.junit.Assert;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;
import java.util.List;
/**
 * UserMapperTest.
 */
@RunWith(SpringRunner.class)
@SpringBootTest
public class UserMapperTest {
 /**
 * 　　在Idea的spring工程裏，經常會遇到Could not autowire.
 * No beans of 'xxxx' type found的錯誤提示。但程序的編譯和運行都是沒有問題的，
 * 這個錯誤提示並不會產生影響。但紅色的錯誤提示在有些有強迫症的程序員眼裏，多多少少有些不太舒服。
 *
 * 解決方案
 　　降低Autowired檢測的級別，將Severity的級別由之前的error改成warning或其它可以忽略的級別。
 */
 @Autowired
 private UserMapper UserMapper;
 @Test
 public void testInsert() throws Exception {
 UserMapper.insert(new UserEntity("aa", "a123456", UserSexEnum.MAN));
 UserMapper.insert(new UserEntity("bb", "b123456", UserSexEnum.WOMAN));
 UserMapper.insert(new UserEntity("cc", "b123456", UserSexEnum.WOMAN));
 Assert.assertEquals(3, UserMapper.getAll().size());
 }
 @Test
 public void testQuery() throws Exception {
 List users = UserMapper.getAll();
 System.out.println(users.toString());
 }
 @Test
 public void testUpdate() throws Exception {
 String id= "30";
 Long userId = Long.valueOf(id).longValue();
 UserEntity user = UserMapper.getOne(userId);
 System.out.println(user.toString());
 user.setNickName("Bobby");
 UserMapper.update(user);
 Assert.assertTrue(("Bobby".equals(UserMapper.getOne(userId).getNickName())));
 }
}

2 整合Swagger2

2.1 添加Swagger2 依賴




 io.springfox
 springfox-swagger2
 2.4.0



 io.springfox
 springfox-swagger-ui
 2.4.0

2.2 創建Swagger2 配置類：

在Application.java 同級創建一個Swagger2 的配置類：

package com.pingkeke.springBoot;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import springfox.documentation.builders.ApiInfoBuilder;
import springfox.documentation.builders.PathSelectors;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;
import springfox.documentation.swagger2.annotations.EnableSwagger2;
/**
 * Swagger2 的配置類.
 */
@Configuration
@EnableSwagger2
public class Swagger2 {
 @Bean
 public Docket webApi() {
 return new Docket(DocumentationType.SWAGGER_2)
 .groupName("DemoAPI接口文檔")
 .apiInfo(apiInfo())
 .select()
 .apis(RequestHandlerSelectors.basePackage("com.pingkeke.springBoot.controller"))
 .paths(PathSelectors.any()).build();
 }
 private ApiInfo apiInfo() {
 return new ApiInfoBuilder()
 .title("Demo使用Swagger2構建RESTful APIs")
 .description("用戶服務")
 .contact(new Contact("Bobby", "http://petstore.swagger.io/v2/swagger.json", "[email protected]"))
 .version("1.0")
 .build();
 }
}

2.3 在需要生成Api 的接口添加註解:

package com.pingkeke.springBoot.controller;
import com.pingkeke.springBoot.entity.UserEntity;
import com.pingkeke.springBoot.mapper.UserMapper;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiImplicitParam;
import io.swagger.annotations.ApiImplicitParams;
import io.swagger.annotations.ApiOperation;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;
import java.util.List;
/**
 * UserController.
 * spring boot如何做呢，只需要類添加 @RestController 即可，默認類中的方法都會以json的格式返回
 *
 http://localhost:8080/swagger-ui.html
 *
 */
@Api(tags = "用戶管理相關接口")
@RestController
@RequestMapping(value="/users") // 通過這裏配置使下面的映射都在/users下
public class UserController {
 @Autowired
 private UserMapper userMapper;
 @ApiOperation(value="獲取用戶列表", notes="")
 @RequestMapping(value={""}, method= RequestMethod.GET)
 public List getUserList() {
 List users=userMapper.getAll();
 return users;
 }
 @ApiOperation(value="創建用戶", notes="根據User對象創建用戶")
 @ApiImplicitParam(name = "user", value = "用戶詳細實體user", required = true, dataType = "User")
 @RequestMapping(value="", method=RequestMethod.POST)
 public void postUser(@RequestBody UserEntity user) {
 userMapper.insert(user);
 }
 @ApiOperation(value="獲取用戶詳細信息", notes="根據url的id來獲取用戶詳細信息")
 @ApiImplicitParam(name = "id", value = "用戶ID", required = true, paramType="path", dataType = "Long")
 @RequestMapping(value="/{id}", method=RequestMethod.GET)
 public UserEntity getUser(@PathVariable Long id) {
 UserEntity user=userMapper.getOne(id);
 return user;
 }
 @ApiOperation(value="更新用戶詳細信息", notes="根據url的id來指定更新對象，並根據傳過來的user信息來更新用戶詳細信息")
 @ApiImplicitParams({
 @ApiImplicitParam(name = "id", value = "用戶ID", required = true, paramType="path", dataType = "Long"),
 @ApiImplicitParam(name = "user", value = "用戶詳細實體user", required = true, dataType = "User")
 })
 @RequestMapping(value="/{id}", method=RequestMethod.PUT)
 public void putUser(@PathVariable Long id, @RequestBody UserEntity user) {
 userMapper.update(user);
 }
 @ApiOperation(value="刪除用戶", notes="根據url的id來指定刪除對象")
 @ApiImplicitParam(name = "id", value = "用戶ID", required = true, paramType="path", dataType = "Long")
 @RequestMapping(value="/{id}", method=RequestMethod.DELETE)
 public void deleteUser(@PathVariable Long id) {
 userMapper.delete(id);
 }
}

完成上述代碼添加上，啓動Spring Boot程序，訪問：http://localhost:8080/swagger-ui.html

。就能看到前文所展示的RESTful API的頁面。我們可以再點開具體的API請求，以POST類型的/users請求爲例，可找到上述代碼中我們配置的Notes信息以及參數user的描述信息，如下圖所示。

swagger-ui

3 極簡xml版本

極簡xml版本保持映射文件的老傳統，優化主要體現在不需要實現dao的是實現層，系統會自動根據方法名在映射文件中找對應的sql.

3.1 配置

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

#實體類掃描包
mybatis.type-aliases-package=com.pingkeke.springBoot.entity
#駝峯命名
mybatis.configuration.mapUnderscoreToCamelCase=true
#Mapper.xml文件掃描目錄
mybatis.config-locations=classpath:mybatis/mybatis-config.xml
mybatis.mapper-locations=classpath:mybatis/mapper/*.xml

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

mybatis-config.xml 配置

這裏也可以添加一些mybatis基礎的配置

3.2 添加User的映射文件




 
 
 
 
 
 
 
 
 id, userName, passWord, user_sex, nick_name
 
 
 
 
 INSERT INTO
 users
 (userName,passWord,user_sex)
 VALUES
 (#{userName}, #{passWord}, #{userSex})
 
 
 UPDATE
 users
 SET
 userName = #{userName},
 passWord = #{passWord},
 nick_name = #{nickName}
 WHERE
 id = #{id}
 
 
 DELETE FROM
 users
 WHERE
 id =#{id}

其實就是把上個版本中mapper的sql搬到了這裏的xml中了。

3.3 編寫Dao層的代碼

package com.pingkeke.springBoot.mapper;
import com.pingkeke.springBoot.entity.UserEntity;
import java.util.List;
/**
 * UserMapper.
 * 對比上一步這裏全部只剩了接口方法。
 */
public interface UserMapper {
 List getAll();
 UserEntity getOne(Long id);
 void insert(UserEntity user);
 void update(UserEntity user);
 void delete(Long id);
}

對比上一步這裏全部只剩了接口方法。

3.4 使用

使用和上個版本沒有任何區別。

3.5 如何選擇

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

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

Spring Boot如何優雅的整合Mybatis

1 無配置文件註解版

2 整合Swagger2

3 極簡xml版本

熱門新聞

週熱門

Spring Boot如何優雅的整合Mybatis

1 無配置文件註解版

2 整合Swagger2

3 極簡xml版本

火箭的飛行原理和飛機的飛行原理有什麼不同？

區塊鏈技術是怎麼變成幣的？

17歲沒讀書了，想學一個跟得上時代發展的技術手藝，有哪些推薦嗎？

區塊鏈技術實際上有什麼用？

美國在 5G 技術上真的落後了嗎？

今年23，不想做銷售了，想做一個靠技術靠手藝喫飯的人，當下行情有什麼好的推薦的？

如果美國用他們的發動機全部技術來換取中國的5g全部技術，中國該換嗎？

未來3D列印會替代焊接技術嗎？

中國在全球的 5G 技術標準、專利及市場中究竟處於什麼地位？是否領先？

科學技術和科技公司的發展，與社會產生了哪些矛盾？未來將如何解決？

web安全需不需要學習sql資料庫？

sql資料庫中什麼情況該加索引index？

在oracle中，select * from dual where =為什麼返回的是空？

學習SQL怎麼開頭？

sql如何獲取 使用distinct後的record所對應的原表id？

熱門新聞

週熱門

sql如何獲取使用distinct後的record所對應的原表id？