SpringBoot整合MyBatis-plus
第一步:添加必要的依賴
如果想學習Java工程化、高性能及分布式、深入淺出。微服務、Spring,MyBatis,Netty源碼分析的朋友可以加我的Java高級交流:854630135,群裏有阿裏大牛直播講解技術,以及Java大型互聯網技術的視頻免費分享給大家。
第一種是在已存在MyBatis的情況下,直接添加mybatis-plus包即可。
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus</artifactId>
<version>2.1.8</version>
第二種是直接添加mybatis-plus的starter,它會自動導入mybatis的依賴包及其他相關依賴包
<dependency>
<groupId>com.baomidou</groupId>
<artifactId>mybatis-plus-boot-starter</artifactId>
<version>3.0.1</version>
</dependency>
第二步:添加必要的配置
註意:Mybatis-plus是MyBatis的再封裝,添加MyBatis-plus之後我們的設置針對的應該是MyBatis-plus,而不是MyBatis。
mybatis-plus:
mapper-locations: classpath:/mapper/.xml
type-aliases-package: com.example.springbootdemo.entity
type-aliases-super-type: java.lang.Object
type-handlers-package: com.example.springbootdemo.typeHandler
type-enums-package: com.example.springbootdemo.enums
第三步:添加必要的配置類
@EnableTransactionManagement@Configuration
public class MyBatisPlusConfig {
// mybatis-plus分頁插件@Bean
br/>@Bean
return new PaginationInterceptor();
}
}
第四步:定義實體
如果想學習Java工程化、高性能及分布式、深入淺出。微服務、Spring,MyBatis,Netty源碼分析的朋友可以加我的Java高級交流:854630135,群裏有阿裏大牛直播講解技術,以及Java大型互聯網技術的視頻免費分享給大家。
@Data@Builder
br/>@Builder
br/>@EqualsAndHashCode
br/>@AllArgsConstructor
public class Animal {
@TableId(value = "ID",type = IdType.AUTO)
private Integer id;
@TableField(value = "NAME",exist = true)
private String name;
@TableField(value = "TYPE",exist = true)
private AnimalType type;
@TableField(value = "SEX",exist = true)
private AnimalSex sex;
@TableField(value = "MASTER",exist = true)
private String master;
}
public enum AnimalType implements IEnum {
CAT("1","貓"),DOG("2","狗"),TIGER("3","虎"),MOUSE("4","鼠"),MONKEY("5","猴"),LOAN("6","獅"),OTHER("7","其他");
private final String value;
private final String desc;
AnimalType(final String value,final String desc){
this.value=value;
this.desc = desc;}
@Override
br/>}
@Override
return value;
}
public String getDesc() {
return desc;
}
}
public enum AnimalSex implements IEnum {
MALE("1","公"),FEMALE("2","母");
private final String value;
private final String desc;
AnimalSex(final String value,final String desc){
this.value = value;
this.desc = desc;}
@Override
br/>}
@Override
return value;
}
public String getDesc() {
return desc;
}
}
第五步:定義mapper接口
public interface AnimalRepository extends BaseMapper<Animal> {
}
解說:使用MyBatis Plus後Mapper只要繼承BaseMapper接口即可,即使不添加XML映射文件也可以實現該接口提供的增刪改查功能,還可以配合Wrapper進行條件操作,當然這些操作都僅僅限於單表操作,一旦涉及多表聯查,那麽還是乖乖添加**Mapper.xml來自定義SQL吧!!!
第六步:定義service(重點)
@Service@Log4j2
br/>@Log4j2
br/>@Autowired
//增
public ResponseEntity<Animal> addAnimal(final Animal animal) {
animalRepository.insert(animal);
return ResponseEntity.ok(animal);
}
//刪
public ResponseEntity<Integer> deleteAnimalById(final int id){
return ResponseEntity.ok(animalRepository.deleteById(id));
}
public ResponseEntity<Integer> deleteAnimals(final Animal animal){
return ResponseEntity.ok(animalRepository.delete(packWrapper(animal, WrapperType.QUERY)));
}
public ResponseEntity<Integer> deleteAnimalsByIds(List<Integer> ids){
return ResponseEntity.ok(animalRepository.deleteBatchIds(ids));
}
public ResponseEntity<Integer> deleteAnimalsByMap(final Animal animal){
Map<String, Object> params = new HashMap<>();
if(Objects.nonNull(animal.getId())){
params.put("ID",animal.getId());
}
if(StringUtils.isNotEmpty(animal.getName())){
params.put("NAME", animal.getName());
}
if(Objects.nonNull(animal.getType())){
params.put("TYPE", animal.getType());
}
if(Objects.nonNull(animal.getSex())){
params.put("SEX", animal.getSex());
}
if (StringUtils.isNotEmpty(animal.getMaster())){
params.put("MASTER", animal.getMaster());
}
return ResponseEntity.ok(animalRepository.deleteByMap(params));
}
//改
public ResponseEntity<Integer> updateAnimals(final Animal animal, final Animal condition){
return ResponseEntity.ok(animalRepository.update(animal, packWrapper(condition, WrapperType.UPDATE)));
}
public ResponseEntity<Integer> updateAnimal(final Animal animal){
Wrapper<Animal> animalWrapper = new UpdateWrapper<>();
((UpdateWrapper<Animal>) animalWrapper).eq("id",animal.getId());
return ResponseEntity.ok(animalRepository.update(animal, animalWrapper));
}
//查
public ResponseEntity<Animal> getAnimalById(final int id){
return ResponseEntity.ok(animalRepository.selectById(id));
}
public ResponseEntity<Animal> getOneAnimal(final Animal animal){
return ResponseEntity.ok(animalRepository.selectOne(packWrapper(animal, WrapperType.QUERY)));
}
public ResponseEntity<List<Animal>> getAnimals(final Animal animal){
return ResponseEntity.ok(animalRepository.selectList(packWrapper(animal, WrapperType.QUERY)));
}
public ResponseEntity<List<Animal>> getAnimalsByIds(List<Integer> ids){
return ResponseEntity.ok(animalRepository.selectBatchIds(ids));
}
public ResponseEntity<List<Animal>> getAnimalsByMap(final Animal animal){
Map<String, Object> params = new HashMap<>();
if(Objects.nonNull(animal.getId())){
params.put("ID",animal.getId());
}
if(StringUtils.isNotEmpty(animal.getName())){
params.put("NAME", animal.getName());
}
if(Objects.nonNull(animal.getType())){
params.put("TYPE", animal.getType());
}
if(Objects.nonNull(animal.getSex())){
params.put("SEX", animal.getSex());
}
if (StringUtils.isNotEmpty(animal.getMaster())){
params.put("MASTER", animal.getMaster());
}
return ResponseEntity.ok(animalRepository.selectByMap(params));
}
public ResponseEntity<List<Map<String, Object>>> getAnimalMaps(final Animal animal){
return ResponseEntity.ok(animalRepository.selectMaps(packWrapper(animal, WrapperType.QUERY)));
}
//查個數
public ResponseEntity<Integer> getCount(final Animal animal){
return ResponseEntity.ok(animalRepository.selectCount(packWrapper(animal, WrapperType.QUERY)));
}
//分頁查詢
public ResponseEntity<Page<Animal>> getAnimalPage(final Animal animal,final int pageId,final int pageSize){
Page<Animal> page = new Page<>();
page.setCurrent(pageId);
page.setSize(pageSize);
return ResponseEntity.ok((Page<Animal>) animalRepository.selectPage(page,packWrapper(animal, WrapperType.QUERY)));
}
private Wrapper<Animal> packWrapper(final Animal animal, WrapperType wrapperType){
switch (wrapperType){
case QUERY:
QueryWrapper<Animal> wrapper = new QueryWrapper<>();
if (Objects.nonNull(animal.getId()))
wrapper.eq("ID", animal.getId());
if (StringUtils.isNotEmpty(animal.getName()))
wrapper.eq("name", animal.getName());
if (Objects.nonNull(animal.getType()))
wrapper.eq("type", animal.getType());
if (Objects.nonNull(animal.getSex()))
wrapper.eq("sex", animal.getSex());
if (StringUtils.isNotEmpty(animal.getMaster()))
wrapper.eq("master", animal.getMaster());
return wrapper;
case UPDATE:
UpdateWrapper<Animal> wrapper2 = new UpdateWrapper<>();
if (Objects.nonNull(animal.getId()))
wrapper2.eq("ID", animal.getId());
if (StringUtils.isNotEmpty(animal.getName()))
wrapper2.eq("name", animal.getName());
if (Objects.nonNull(animal.getType()))
wrapper2.eq("type", animal.getType());
if (Objects.nonNull(animal.getSex()))
wrapper2.eq("sex", animal.getSex());
if (StringUtils.isNotEmpty(animal.getMaster()))
wrapper2.eq("master", animal.getMaster());
return wrapper2;
case QUERYLAMBDA:
LambdaQueryWrapper<Animal> wrapper3 = new QueryWrapper<Animal>().lambda();
if (Objects.nonNull(animal.getId()))
wrapper3.eq(Animal::getId, animal.getId());
if (StringUtils.isNotEmpty(animal.getName()))
wrapper3.eq(Animal::getName, animal.getName());
if (Objects.nonNull(animal.getType()))
wrapper3.eq(Animal::getType, animal.getType());
if (Objects.nonNull(animal.getSex()))
wrapper3.eq(Animal::getSex, animal.getSex());
if (StringUtils.isNotEmpty(animal.getMaster()))
wrapper3.eq(Animal::getMaster, animal.getMaster());
return wrapper3;
case UPDATELAMBDA:
LambdaUpdateWrapper<Animal> wrapper4 = new UpdateWrapper<Animal>().lambda();
if (Objects.nonNull(animal.getId()))
wrapper4.eq(Animal::getId, animal.getId());
if (StringUtils.isNotEmpty(animal.getName()))
wrapper4.eq(Animal::getName, animal.getName());
if (Objects.nonNull(animal.getType()))
wrapper4.eq(Animal::getType, animal.getType());
if (Objects.nonNull(animal.getSex()))
wrapper4.eq(Animal::getSex, animal.getSex());
if (StringUtils.isNotEmpty(animal.getMaster()))
wrapper4.eq(Animal::getMaster, animal.getMaster());
return wrapper4;
default:return null;
}
}
}
enum WrapperType{
UPDATE,UPDATELAMBDA,QUERY,QUERYLAMBDA;
}
第七步:定義controller
如果想學習Java工程化、高性能及分布式、深入淺出。微服務、Spring,MyBatis,Netty源碼分析的朋友可以加我的Java高級交流:854630135,群裏有阿裏大牛直播講解技術,以及Java大型互聯網技術的視頻免費分享給大家。
@RestController@RequestMapping("animal")
br/>@RequestMapping("animal")
br/>@Log4j2
br/>@Autowired
@RequestMapping(value = "addAnimal",method = RequestMethod.PUT)
@ApiOperation(value = "添加動物",notes = "添加動物",httpMethod = "PUT")
public ResponseEntity<Animal> addAnimal(final Animal animal){
return animalService.addAnimal(animal);
}
@RequestMapping(value = "deleteAnimalById", method = RequestMethod.DELETE)
@ApiOperation(value = "刪除一個動物",notes = "根據ID刪除動物",httpMethod = "DELETE")
public ResponseEntity<Integer> deleteAnimalById(final int id){
return animalService.deleteAnimalById(id);
}
@RequestMapping(value = "deleteAnimalsByIds",method = RequestMethod.DELETE)
@ApiOperation(value = "刪除多個動物",notes = "根據Id刪除多個動物",httpMethod = "DELETE")
public ResponseEntity<Integer> deleteAnimalsByIds(Integer[] ids){
return animalService.deleteAnimalsByIds(Arrays.asList(ids));
}
@RequestMapping(value = "deleteAnimals", method = RequestMethod.DELETE)
@ApiOperation(value = "刪除動物",notes = "根據條件刪除動物",httpMethod = "DELETE")
public ResponseEntity<Integer> deleteAnimalsByMaps(final Animal animal){
return animalService.deleteAnimalsByMap(animal);
}
@RequestMapping(value = "deleteAnimals2", method = RequestMethod.DELETE)
@ApiOperation(value = "刪除動物",notes = "根據條件刪除動物",httpMethod = "DELETE")
public ResponseEntity<Integer> deleteAnimals(final Animal animal){
return animalService.deleteAnimals(animal);
}
@RequestMapping(value = "getAnimalById",method = RequestMethod.GET)
@ApiOperation(value = "獲取一個動物",notes = "根據ID獲取一個動物",httpMethod = "GET")
public ResponseEntity<Animal> getAnimalById(final int id){
return animalService.getAnimalById(id);
}
// 註意,這裏參數animal不能用RequstBody標註,否則接收不到參數
// @RequestBody只能用在只有一個參數模型的方法中,用於將所有請求體中攜帶的參數全部映射到這個請求參數模型中
@RequestMapping(value = "getAnimalsByPage")
@ApiOperation(value = "分頁獲取動物們",notes = "分頁獲取所有動物", httpMethod = "GET")
public ResponseEntity<Page<Animal>> getAnimalsByPage(@RequestParam final int pageId, @RequestParam final int pageSize, final Animal animal) {
return animalService.getAnimalPage(animal==null?Animal.builder().build():animal, pageId, pageSize);
}
@RequestMapping(value = "updateAnimal")
@ApiOperation(value = "更新動物", notes = "根據條件更新",httpMethod = "POST")
public ResponseEntity<Integer> updateAnimals(final Animal animal){
return animalService.updateAnimal(animal);
}
}
高級功能
代碼生成器
分頁插件
第一步:添加必要的配置
@EnableTransactionManagement@Configuration
br/>@Configuration
public class MyBatisPlusConfig {
@Bean // mybatis-plus分頁插件
public PaginationInterceptor paginationInterceptor() {
return new PaginationInterceptor();
}
}
第二步:添加Mapper
public interface AnimalRepository extends BaseMapper<Animal> {
}
第三步:添加service
@Service@Log4j2
br/>@Log4j2
br/>@Autowired
//...
public Page<Animal> getAnimalsByPage(int pageId,int pageSize) {
Page page = new Page(pageId, pageSize);
return (Page<Animal>)animalRepository.selectPage(page,null);
}
}
邏輯刪除
所謂邏輯刪除是相對於物理刪除而言的,MyBatis Plus默認的刪除操作是物理刪除,即直接調用數據庫的delete操作,直接將數據從數據庫刪除,但是,一般情況下,我們在項目中不會直接操作delete,為了保留記錄,我們只是將其標記為刪除,並不是真的刪除,也就是需要邏輯刪除,MyBatis Plus也提供了實現邏輯刪除的功能,通過這種方式可以將底層的delete操作修改成update操作。
第一步:添加必要的配置
mybatis-plus:
global-config:
db-config:
logic-delete-value: 1 # 邏輯已刪除值(默認為 1)
logic-not-delete-value: 0 # 邏輯未刪除值(默認為 0)
第二步:添加必要的配置類
@Configuration
public class MyBatisPlusConfiguration {@Bean
br/>@Bean
return new LogicSqlInjector();
}
}
第三步:添加字段isDel和註解
@TableLogic
private Integer isDel;
如此一來,我們再執行delete相關操作的時候,底層就會變更為update操作,將isDel值修改為1。
註意:通過此種方式刪除數據後,實際數據還存在於數據庫中,只是字段isDel值改變了,雖然如此,但是再通過MyBatis Plus查詢數據的時候卻會將其忽略,就好比不存在一般。
即通過邏輯刪除的數據和物理刪除的外在表現是一致的,只是內在機理不同罷了。
枚舉自動註入
第一種方式
使用註解@EnumValue
使用方式:定義普通枚舉,並在其中定義多個屬性,將該註解標註於其中一個枚舉屬性之上,即可實現自動映射,使用枚舉name傳遞,實際入庫的卻是添加了註解的屬性值,查詢也是如此,可以將庫中數據與添加註解的屬性對應,從而獲取到枚舉值name。
第二種方式
Mybatis Plus中定義了IEnum用來統籌管理所有的枚舉類型,我們自定義的枚舉只要實現IEnum接口即可,在MyBatis Plus初始化的時候,會自動在MyBatis中handler緩存中添加針對IEnum類型的處理器,我們的自定義的枚舉均可使用這個處理器進行處理來實現自動映射。
步驟一:添加必要的配置
mybatis-plus.type-enums-package: com.example.springbootdemo.enums
步驟二:自定義枚舉
public enum AnimalType implements IEnum {
CAT("1","貓"),DOG("2","狗"),TIGER("3","虎"),MOUSE("4","鼠"),MONKEY("5","猴"),LOAN("6","獅"),OTHER("7","其他");
private final String value;
private final String desc;
AnimalType(final String value,final String desc){
this.value=value;
this.desc = desc;}
@Override
br/>}
@Override
return value;
}
public String getDesc() {
return desc;
}
}
註意:一定要實現IEnum接口,否則無法實現自動註入。
Sql自動註入
性能分析插件
第一步:添加必要的配置
@EnableTransactionManagement@Configuration
br/>@Configuration
public class MyBatisPlusConfig {//...
//sql執行效率插件(性能分析插件)
@Bean
br/>//...
//sql執行效率插件(性能分析插件)
@Bean
public PerformanceInterceptor performanceInterceptor() {
return new PerformanceInterceptor();
}
}
說明:
性能分析攔截器,用於輸出每條 SQL 語句及其執行時間:
maxTime:SQL 執行最大時長,超過自動停止運行,有助於發現問題。
format:SQL SQL是否格式化,默認false。
註意:性能分析工具最好不要在生產環境部署,只在開發、測試環境部署用於查找問題即可。
樂觀鎖插件
第一步:添加必要的配置
@EnableTransactionManagement@Configuration
br/>@Configuration
public class MyBatisPlusConfig {
//...
// mybatis-plus樂觀鎖插件@Bean
br/>@Bean
return new OptimisticLockerInterceptor();
}
}
第二步:添加@Version
@Version
private int version;
註意:
@Version支持的數據類型只有:int,Integer,long,Long,Date,Timestamp,LocalDateTime;
整數類型下 newVersion = oldVersion + 1;
newVersion 會回寫到 entity 中
僅支持 updateById(id) 與 update(entity, wrapper) 方法
在 update(entity, wrapper) 方法下, wrapper 不能復用!!!
實體主鍵配置
@Getter
public enum IdType {
/**
- 數據庫ID自增
*/
AUTO(0),
/** - 該類型為未設置主鍵類型
*/
NONE(1),
/** - 用戶輸入ID
- 該類型可以通過自己註冊自動填充插件進行填充
/
INPUT(2),
/ 以下3種類型、只有當插入對象ID 為空,才自動填充。 */
/** - 全局唯一ID (idWorker)
*/
ID_WORKER(3),
/** - 全局唯一ID (UUID)
*/
UUID(4),
/** - 字符串全局唯一ID (idWorker 的字符串表示)
*/
ID_WORKER_STR(5);
private int key;
IdType(int key) {
this.key = key;
}
}
AUTO:自增,適用於類似MySQL之類自增主鍵的情況
NONE:不設置???
INPUT:通過第三方進行逐漸遞增,類似Oracle數據庫的隊列自增
ID_WORKER:全局唯一ID,當插入對象ID為空時,自動填充
UUID:全局唯一ID,當插入對象ID為空時,自動填充,一般情況下UUID是無序的
ID_WORKER_STR:字符串全局唯一ID,當插入對象ID為空時,自動填充
註意事項
最好不要和devTools一起使用,因為devTools中的RestartClassLoader會導致MyBatis Plus中的枚舉自動映射失敗,因為類加載器的不同從而在MyBatis的TypeHasnlerRegistry的TYPE_HANDLER_MAP集合中找不到對應的枚舉類型(存在這個枚舉類型,只不過是用AppClassLoader加載的,不同的加載器導致類型不同)
MyBatis Plus和JPA分頁有些不同,前者從1開始計頁數,後者則是從0開始。
如果想學習Java工程化、高性能及分布式、深入淺出。微服務、Spring,MyBatis,Netty源碼分析的朋友可以加我的Java高級交流:854630135,群裏有阿裏大牛直播講解技術,以及Java大型互聯網技術的視頻免費分享給大家。
SpringBoot整合MyBatis-plus