spring boot集成mybatis

时间:2024-11-14 12:33:39

大家在开发的时候,会喜欢jdbcTemplate操作数据库,有喜欢JPA操作数据库的,有喜欢MyBatis操作数据库的,对于这些我个人觉得哪个使用顺手就使用哪个就好了,并没有一定要使用哪个,个人在实际中会集成多个,这样保存的数据的时候,选择一个最方便的也就是JPA,查询的时候,或者统计的时候,选择一个效率最高的,也就是直接使用SQL语句方式,当然这并一定要这样的,现在优化方式又很多。那么这节说说怎么在Spring Boot中使用MyBatis吧。主要分几个步骤进行讲解:

(1)新建maven project;
(2)在文件中引入相关依赖;
(3)创建启动类
(4)在添加配置文件;
(5)编写Demo测试类;
(6)编写DemoMapper;
(7)编写DemoService
(8)编写DemoController;
(9)加入PageHelper


接下里我们一起来进行实现吧。


(1)新建maven project;

新建一个maven project,取名为:spring-boot-mybatis


(2)在文件中引入相关依赖;

在中加入依赖:mysql驱动,mybatis依赖包,mysql分页PageHelper:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
< project  xmlns = "/POM/4.0.0" xmlns:xsi = "http:///2001/XMLSchema-instance"
   xsi:schemaLocation = "/POM/4.0.0 /xsd/maven-4.0." >
   < modelVersion >4.0.0</ modelVersion >
  
   < groupId ></ groupId >
   < artifactId >spring-boot-mybatis</ artifactId >
   < version >0.0.1-SNAPSHOT</ version >
   < packaging >jar</ packaging >
  
   < name >spring-boot-mybatis</ name >
   < url ></ url >
  
   < properties >
     < >UTF-8</ >
     <!-- jdk版本号,angel在这里使用1.8,大家修改为大家本地配置的jdk版本号即可 -->
     < >1.8</ >
   </ properties >
  
     <!--
        spring boot 父节点依赖,
        引入这个之后相关的引入就不需要添加version配置,
        spring boot会自动选择最合适的版本进行添加。
      -->
     < parent >
        < groupId ></ groupId >
        < artifactId >spring-boot-starter-parent</ artifactId >
        < version >1.3.</ version >
     </ parent >
  
   < dependencies >
        
    
     <!-- spring boot web支持:mvc,aop... -->
     < dependency >
        < groupId ></ groupId >
        < artifactId >spring-boot-starter-web</ artifactId >
     </ dependency >
    
    
     <!-- mysql 数据库驱动. -->
     < dependency >
        < groupId >mysql</ groupId >
        < artifactId >mysql-connector-java</ artifactId >
     </ dependency >
    
    
     <!--  
            spring-boot mybatis依赖:
           
            请不要使用1.0.0版本,因为还不支持拦截器插件,
             1.1.1 是博主写帖子时候的版本,大家使用最新版本即可
          -->
     < dependency >
         < groupId ></ groupId >
         < artifactId >mybatis-spring-boot-starter</ artifactId >
         < version >1.1.1</ version >
     </ dependency >
    
     <!--
         MyBatis提供了拦截器接口,我们可以实现自己的拦截器,
         将其作为一个plugin装入到SqlSessionFactory中。
        Github上有位开发者写了一个分页插件,我觉得使用起来还可以,挺方便的。
        Github项目地址: /pagehelper/Mybatis-PageHelper
      -->  
     < dependency >
         < groupId ></ groupId >
         < artifactId >pagehelper</ artifactId >
         < version >4.1.0</ version >
     </ dependency >
        
   </ dependencies >
</ project >

(3)创建启动类 >

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
package  ;
  
import  ;
import  ;
import  ;
  
/**
  * 启动类;
  
  * @version v.0.1
  */
@SpringBootApplication
@MapperScan ( ".*.mapper" )
publicclass App {
     publicstaticvoid main(String[] args) {
        (App. class , args);
     }
}

 这里和以往不一样的地方就是MapperScan的注解,这个是会扫描该包下的接口。

这里我们使用注解的方式进行使用MyBatis,当然您也可以使用xml文件的方式进行使用。


 (4)在添加配置文件;

 Mysql的配置,这个我们已经是轻车熟路了:

1
2
3
4
5
6
7
8
9
10
11
########################################################
###datasource
########################################################
 = jdbc:mysql: //localhost:3306/test
 = root
 = root
 = 
-active= 20
-idle= 8
-idle= 8
-size= 10



(5)编写Demo测试类;

  测试实体类:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
package  ;
  
/**
  * 测试类.
 
  * @version v.0.1
  */
publicclass Demo {
     private  long  id;
     private  String name;
     public  long  getId() {
        returnid;
     }
     public  void  setId(longid) {
        this .id = id;
     }
     public  String getName() {
        return  name;
     }
     public  void  setName(String name) {
        this .name = name;
     }
}


(6)编写DemoMapper;

MyBatis使用类,这里主要是@select进行使用.

.mapper.DemoMappper:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
package  ;
  
import  ;
  
import  ;
  
import  ;
  
public  interface  DemoMappper {
    
     @Select ( "select *from Demo where name = #{name}" )
     public  List<Demo> likeName(String name);
    
     @Select ( "select *from Demo where id = #{id}" )
     public  Demo getById( long  id);
    
     @Select ( "select name from Demo where id = #{id}" )
     public  String getNameById( long  id);
    
    
}


(7)编写DemoService

 :

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
package  ;
  
import  ;
  
import  ;
import  ;
  
import  ;
import  ;
  
@Service
public  class  DemoService {
     @Autowired
     private  DemoMappper demoMappper;
    
     public  List<Demo> likeName(String name){
         return  (name);
     }
}


(8)编写DemoController;


1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
package  ;
  
import  ;
  
import  ;
import  ;
import  ;
  
import  ;
import  ;
import  ;
  
@RestController
publicclass DemoController {
     @Autowired
     private  DemoService demoService;
    
     @RequestMapping ( "/likeName" )
     public  List<Demo> likeName(String name){
        return  (name);
     }
    
}

运行访问:http://127.0.0.1:8080/likeName?name=张三  就可以看到全部的数据了。


(9)加入PageHelper


       这里与其说集成分页插件,不如说是介绍如何集成一个plugin。MyBatis提供了拦截器接口,我们可以实现自己的拦截器,将其作为一个plugin装入到SqlSessionFactory中。

Github上有位开发者写了一个分页插件,我觉得使用起来还可以,挺方便的。

Github项目地址: /pagehelper/Mybatis-PageHelper

当然需要添加相应的依赖包了,我们在上面已经配置了,这里简单说下:

1
2
3
4
5
< dependency >
     < groupId ></ groupId >
     < artifactId >pagehelper</ artifactId >
     < version >4.1.0</ version >
</ dependency >


新增

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
package  ;
  
import  ;
  
import  ;
import  ;
  
import  ;
  
/**
  * 注册MyBatis分页插件PageHelper
  *
  * @version v.0.1
  */
@Configuration
public  class  MyBatisConfiguration {
    
     @Bean
     public  PageHelper pageHelper() {
        ( "()" );
         PageHelper pageHelper =  new  PageHelper();
         Properties p =  new  Properties();
         ( "offsetAsPageNum" "true" );
         ( "rowBoundsWithCount" "true" );
         ( "reasonable" "true" );
         (p);
         return  pageHelper;
     }
    
}

分页查询测试

1
2
3
4
5
@RequestMapping ( "/likeName" )
     public  List<Demo> likeName(String name){
         ( 1 , 1 );
          return  (name);
     }

这个使用起来特别的简单,只是在原来查询的代码之前加入了一句:

1
( 1 , 1 );

第一个参数是第几页;

第二个参数是每页显示条数。

访问http://127.0.0.1:8080/likeName?name=张三 进行测试。