Mybatis3

Mybatis3.x与Spring4.x整合



一、搭建开发环境



1.1、使用Maven创建Web项目



执行如下命令：



mvnarchetype:create-DgroupId=me.gacl-DartifactId=spring4-mybatis3-DarchetypeArtifactId=maven-archetype-webapp-DinteractiveMode=false

复制代码

1
2xsi:schemaLocation="http://maven.apache.org/POM/4.0.0http://maven.apache.org/maven-v4_0_0.xsd">

34.0.0

4me.gacl

5spring4-mybatis3

6war

71.0-SNAPSHOT

8spring4-mybatis3MavenWebapp

9http://maven.apache.org

10

11

12junit

13junit

143.8.1

15test

16

17

18

19spring4-mybatis3

20

21

复制代码

修改spring4-mybatis3MavenWebapp部分，把"MavenWebapp"这部分包含空格的内容去掉，否则Maven在编译项目时会因为空格的原因导致一些莫名其妙的错误出现，修改成：spring4-mybatis3。



另外，把以下内容删掉：



1

2junit

3junit

43.8.1

5test

6

这部分是junit的jar包依赖信息，这个版本太低了，我们不使用这个Junit测试版本，修改过后的pom.xml内容如下：



复制代码

1
2xsi:schemaLocation="http://maven.apache.org/POM/4.0.0http://maven.apache.org/maven-v4_0_0.xsd">

34.0.0

4me.gacl

5spring4-mybatis3

6war

71.0-SNAPSHOT

8spring4-mybatis3

9http://maven.apache.org

10

11

12

13

14spring4-mybatis3

15

16

复制代码

1.2、将创建好的项目导入MyEclipse中



二、创建数据库和表(针对MySQL)



SQL脚本如下：



复制代码

CreateDATABASEspring4_mybatis3;

USEspring4_mybatis3;



DROPTABLEIFEXISTSt_user;

CREATETABLEt_user(

user_idchar(32)NOTNULL,

user_namevarchar(30)DEFAULTNULL,

user_birthdaydateDEFAULTNULL,

user_salarydoubleDEFAULTNULL,

PRIMARYKEY(user_id)

)ENGINE=InnoDBDEFAULTCHARSET=utf8;

复制代码

创建好的数据库和表如下：







三、使用generator工具生成代码



在网上找到了一个generator工具可以根据创建好的数据库表生成MyBatis的表对应的实体类，SQL映射文件和dao，找到generator工具根目录下的generator.xml文件，这个文件是用来配置代码生成规则的，

编辑generator.xml文件，



复制代码

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

复制代码

打开命令行窗口，切换到生成工具的根目录下，执行如下命令：



java-jarmybatis-generator-core-1.3.2.jar-configfilegenerator.xml-overwrite

如下图所示：





刚才我们在generator.xml文件中配置将生成的代码和SQL映射文件放到"C:\Users\gacl\spring4-mybatis3\src\main\java"这个目录下，这个目录就是我们的spring4-mybatis3项目所在目录，我们刷新一下src/main/java目录，就可以看到生成的代码和映射文件了，如下图所示：







生成的代码和映射文件一行都不用改，可以直接应用到项目当中。下面我们看一眼由generator工具生成的代码和映射文件：



1、生成的dao类



复制代码

1packageme.gacl.dao;

2

3importme.gacl.domain.User;

4

5publicinterfaceUserMapper{

6intdeleteByPrimaryKey(StringuserId);

7

8intinsert(Userrecord);

9

10intinsertSelective(Userrecord);

11

12UserselectByPrimaryKey(StringuserId);

13

14intupdateByPrimaryKeySelective(Userrecord);

15

16intupdateByPrimaryKey(Userrecord);

17}

复制代码

生成的UserMapper是一个接口，里面定义了一些操作t_user表的增删改查方法。



2、生成的实体类



复制代码

1packageme.gacl.domain;

2

3importjava.util.Date;

4

5publicclassUser{

6privateStringuserId;

7

8privateStringuserName;

9

10privateDateuserBirthday;

11

12privateDoubleuserSalary;

13

14publicStringgetUserId(){

15returnuserId;

16}

17

18publicvoidsetUserId(StringuserId){

19this.userId=userId==null?null:userId.trim();

20}

21

22publicStringgetUserName(){

23returnuserName;

24}

25

26publicvoidsetUserName(StringuserName){

27this.userName=userName==null?null:userName.trim();

28}

29

30publicDategetUserBirthday(){

31returnuserBirthday;

32}

33

34publicvoidsetUserBirthday(DateuserBirthday){

35this.userBirthday=userBirthday;

36}

37

38publicDoublegetUserSalary(){

39returnuserSalary;

40}

41

42publicvoidsetUserSalary(DoubleuserSalary){

43this.userSalary=userSalary;

44}

45}

复制代码

User类是t_user表的对应的实体类，User类中定义的属性和t_user表中的字段一一对应。



3、生成的SQL映射文件



复制代码

1

2

3

4

5

6

7

8

9

10

11user_id,user_name,user_birthday,user_salary

12

13

14select

15

16fromt_user

17whereuser_id=#{userId,jdbcType=CHAR}

18

19

20deletefromt_user

21whereuser_id=#{userId,jdbcType=CHAR}

22

23

24insertintot_user(user_id,user_name,user_birthday,

25user_salary)

26values(#{userId,jdbcType=CHAR},#{userName,jdbcType=VARCHAR},#{userBirthday,jdbcType=DATE},

27#{userSalary,jdbcType=DOUBLE})

28

29

30insertintot_user

31

32

33user_id,

34

35

36user_name,

37

38

39user_birthday,

40

41

42user_salary,

43

44

45

46

47#{userId,jdbcType=CHAR},

48

49

50#{userName,jdbcType=VARCHAR},

51

52

53#{userBirthday,jdbcType=DATE},

54

55

56#{userSalary,jdbcType=DOUBLE},

57

58

59

60

61updatet_user

62

63

64user_name=#{userName,jdbcType=VARCHAR},

65

66

67user_birthday=#{userBirthday,jdbcType=DATE},

68

69

70user_salary=#{userSalary,jdbcType=DOUBLE},

71

72

73whereuser_id=#{userId,jdbcType=CHAR}

74

75

76updatet_user

77setuser_name=#{userName,jdbcType=VARCHAR},

78user_birthday=#{userBirthday,jdbcType=DATE},

79user_salary=#{userSalary,jdbcType=DOUBLE}

80whereuser_id=#{userId,jdbcType=CHAR}

81

82

复制代码

UserMapper.xml这个文件的内容是编写操作t_user表的SQL语句，重点说一下UserMapper.xml配置中需要注意的几个小细节问题：



1、UserMapper.xml的标签的namespace必须是UserMapper接口的全类名，既



2、UserMapper.xml的定义操作数据库的这些标签的id属性的值必须和UserMapper接口定义的方法名一致，如下图所示：







之所以有上述说的这两点要求，就是为了能够让MyBatis能够根据UserMapper接口和UserMapper.xml文件去自动实现UserMapper接口中定义的相关方法，这样我们就不再需要针对UserMapper接口去编写具体的实现代码了。



四、Spring与MyBatis整合



首先我们要在项目中加入我们需要的相关jar包，我们可以到Maven的中央仓库：http://search.maven.org/找到我们要的相关jar包，如下图所示：







我们只需要在搜索框中输入要找的jar包的名称，点击【SEARCH】按钮，就可以找到我们要的jar包了。



4.1、添加Spring与Mybatis的相关jar包



1、添加spring-core，输入spring-core关键字进行查找，如下图所示：







找到关于spring-core的依赖描述信息，如下图所示：







将





org.springframework

spring-core

4.1.4.RELEASE



复制到项目的pom.xml文件中，如下所示：



复制代码


xsi:schemaLocation="http://maven.apache.org/POM/4.0.0http://maven.apache.org/maven-v4_0_0.xsd">

4.0.0

me.gacl

spring4-mybatis3

war

1.0-SNAPSHOT

spring4-mybatis3

http://maven.apache.org







org.springframework

spring-core

4.1.4.RELEASE









spring4-mybatis3





复制代码

这样Maven就会自动帮我们从Maven的中央仓库中下载spring-core这个jar包到我们的本地仓库，然后将spring-core这个jar包以及它的相关依赖包加入到我们的项目当中，如下所示：







spring4.x与mybatis3.x所需要的相关jar包都可以采用上述所说的方式进行查找，然后添加到项目当中，添加完spring4.x与mybatis3.x相关jar包后，pom.xml文件内容最终如下：



复制代码

1
2xsi:schemaLocation="http://maven.apache.org/POM/4.0.0http://maven.apache.org/maven-v4_0_0.xsd">

34.0.0

4me.gacl

5spring4-mybatis3

6war

71.0-SNAPSHOT

8spring4-mybatis3

9http://maven.apache.org

10

11

12

13org.springframework

14spring-core

154.1.4.RELEASE

16

17

18

19org.springframework

20spring-context

214.1.4.RELEASE

22

23

24

25org.springframework

26spring-tx

274.1.4.RELEASE

28

29

30

31org.springframework

32spring-jdbc

334.1.4.RELEASE

34

35

36

37org.springframework

38spring-test

394.1.4.RELEASE

40

41

42

43org.springframework

44spring-web

454.1.4.RELEASE

46

47

48

49org.aspectj

50aspectjweaver

511.8.5

52

53

54

55org.mybatis

56mybatis

573.2.8

58

59

60

61org.mybatis

62mybatis-spring

631.2.2

64

65

66

67javax.servlet

68javax.servlet-api

693.0.1

70

71

72javax.servlet.jsp

73javax.servlet.jsp-api

742.3.2-b01

75

76

77

78javax.servlet

79jstl

801.2

81

82

83

84mysql

85mysql-connector-java

865.1.34

87

88

89

90com.alibaba

91druid

921.0.12

93

94

95

96junit

97junit

984.12

99test

100

101

102

103spring4-mybatis3

104

105

复制代码





4.2、编写相关配置文件



1、dbconfig.properties



在src/main/resources目录下创建一个dbconfig.properties文件，用于编写连接MySQL数据库的相关信息，dbconfig.properties的内容如下：



driverClassName=com.mysql.jdbc.Driver

validationQuery=SELECT1

jdbc_url=jdbc:mysql://localhost:3306/spring4_mybatis3?useUnicode=true&characterEncoding=UTF-8&zeroDateTimeBehavior=convertToNull

jdbc_username=root

jdbc_password=XDP

2、spring.xml(spring框架的配置文件)



在src/main/resources目录下创建一个spring.xml文件，spring.xml文件就是针对Spring框架编写的核心配置文件，spring.xml的内容如下：



复制代码




xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xmlns:context="http://www.springframework.org/schema/context"

xsi:schemaLocation="

http://www.springframework.org/schema/beans

http://www.springframework.org/schema/beans/spring-beans-3.0.xsd

http://www.springframework.org/schema/context

http://www.springframework.org/schema/context/spring-context-3.0.xsd">













复制代码

我们的spring.xml文件的配置非常简单，就两个配置。

3、spring-mybatis.xml(spring与mybatis整合的配置文件)



在src/main/resources目录下创建一个spring-mybatis.xml文件，spring-mybatis.xml文件就是针对Spring框架与Mybatis框架整合编写的配置文件，spring-mybatis.xml的内容如下：



复制代码















































































































































































































me.gacl.service.

















复制代码





到此，相关的配置文件算是编写完成了，如下图所示：







4.3、进行单元测试



经过以上两个步骤，spring4与mybatis3的整合算是全部完成了。接下来我们要做的工作就算进行单元测试，测试一下spring4与mybatis3的整合是否成功。



1、在src/main/java目录下创建一个me.gacl.service包，然后在me.gacl.service包创建一个UserServiceI接口，如下所示：



复制代码

1packageme.gacl.service;

2

3importme.gacl.domain.User;

4

5publicinterfaceUserServiceI{

6

7/

8添加用户

9@paramuser

10/

11voidaddUser(Useruser);

12

13/

14根据用户id获取用户

15@paramuserId

16@return

17/

18UsergetUserById(StringuserId);

19}

复制代码

2、在src/main/java目录下创建一个me.gacl.service.impl包，然后在me.gacl.service.impl包创建一个针对UserServiceI接口的实现类：UserServiceImpl，如下所示：



复制代码

1packageme.gacl.service.impl;

2

3importorg.springframework.beans.factory.annotation.Autowired;

4importorg.springframework.stereotype.Service;

5importme.gacl.dao.UserMapper;

6importme.gacl.domain.User;

7importme.gacl.service.UserServiceI;

8

9/

10@authorgacl

11使用@Service注解将UserServiceImpl类标注为一个service

12service的id是userService

13/

14@Service("userService")

15publicclassUserServiceImplimplementsUserServiceI{

16

17/

18使用@Autowired注解标注userMapper变量，

19当需要使用UserMapper时，Spring就会自动注入UserMapper

20/

21@Autowired

22privateUserMapperuserMapper;//注入dao

23

24@Override

25publicvoidaddUser(Useruser){

26userMapper.insert(user);

27}

28

29@Override

30publicUsergetUserById(StringuserId){

31returnuserMapper.selectByPrimaryKey(userId);

32}

33}

复制代码





创建好的两个类如下所示：







3、在src/test/java目录下编写单元测试类，新建一个me.gacl.test包，然后在这个包下创建一个MyBatisTest类，代码如下：



复制代码

1packageme.gacl.test;

2

3importjava.util.Date;

4importjava.util.UUID;

5importme.gacl.domain.User;

6importme.gacl.service.UserServiceI;

7//importme.gacl.service.UserServiceI;

8importorg.junit.Before;

9importorg.junit.Test;

10importorg.springframework.context.ApplicationContext;

11importorg.springframework.context.support.ClassPathXmlApplicationContext;

12

13publicclassMyBatisTest{

14

15privateUserServiceIuserService;

16

17/

18这个before方法在所有的测试方法之前执行，并且只执行一次

19所有做Junit单元测试时一些初始化工作可以在这个方法里面进行

20比如在before方法里面初始化ApplicationContext和userService

21/

22@Before

23publicvoidbefore(){

24//使用"spring.xml"和"spring-mybatis.xml"这两个配置文件创建Spring上下文

25ApplicationContextac=newClassPathXmlApplicationContext(newString[]{"spring.xml","spring-mybatis.xml"});

26//从Spring容器中根据bean的id取出我们要使用的userService对象

27userService=(UserServiceI)ac.getBean("userService");

28}

29

30@Test

31publicvoidtestAddUser(){

32//ApplicationContextac=newClassPathXmlApplicationContext(newString[]{"spring.xml","spring-mybatis.xml"});

33//UserServiceIuserService=(UserServiceI)ac.getBean("userService");

34Useruser=newUser();

35user.setUserId(UUID.randomUUID().toString().replaceAll("-",""));

36user.setUserName("白虎神皇xdp");

37user.setUserBirthday(newDate());

38user.setUserSalary(10000D);

39userService.addUser(user);

40}

41

42}

复制代码

执行单元测试代码，这时候会报如下错误：







错误提示是说没有找到"me.gacl.test.MyBatisTest"这个类，这是因为我们没有使用maven编译项目中的类的缘故。



下面我们使用Maven编译项目，选中项目的pom.xml文件→【DebugAs】→【maveninstall】，如下所示：







编译结果如下：







在这里说一下我执行Maveninstall之后遇到的问题，第一次执行Maveninstall命令时，就出现了如下一堆乱七八糟的错误：







后来我把项目删掉，再重新导入项目，然后再执行Clean项目操作之后，如下图所示：







再执行Maveninstall操作又可以正常编译通过了，这让我郁闷了好久，这应该不是我项目配置的原因，而是Maven的原因，具体也不知道为啥会这样。反正这算是一种解决办法吧，如果遇到执行Maveninstall操作不能正常编译通过的情况：可以尝试采用：Mavenclean→Clean项目→Maveninstall这三个步骤去解决问题。



除了可以用常规的Junit进行单元测试之外，我们还可以使用Spring提供的Junit测试框架进行单元测试，在me.gacl.test下新建一个MyBatisTestBySpringTestFramework类，代码如下：



复制代码

1packageme.gacl.test;

2

3importjava.util.Date;

4importjava.util.UUID;

5importme.gacl.domain.User;

6importme.gacl.service.UserServiceI;

7importorg.junit.Test;

8importorg.junit.runner.RunWith;

9importorg.springframework.beans.factory.annotation.Autowired;

10importorg.springframework.test.context.ContextConfiguration;

11importorg.springframework.test.context.junit4.SpringJUnit4ClassRunner;

12

13@RunWith(SpringJUnit4ClassRunner.class)

14//配置了@ContextConfiguration注解并使用该注解的locations属性指明spring和配置文件之后，

15@ContextConfiguration(locations={"classpath:spring.xml","classpath:spring-mybatis.xml"})

16publicclassMyBatisTestBySpringTestFramework{

17

18//注入userService

19@Autowired

20privateUserServiceIuserService;

21

22@Test

23publicvoidtestAddUser(){

24Useruser=newUser();

25user.setUserId(UUID.randomUUID().toString().replaceAll("-",""));

26user.setUserName("xdp_gacl_白虎神皇");

27user.setUserBirthday(newDate());

28user.setUserSalary(10000D);

29userService.addUser(user);

30}

31

32@Test

33publicvoidtestGetUserById(){

34StringuserId="fb1c5941094e400b975f10d9a9d602a3";

35Useruser=userService.getUserById(userId);

36System.out.println(user.getUserName());

37}

38}

复制代码

执行这两个测试方法，是可以正常测试通过的，如下所示：









到此，我们框架的整合测试工作就算是全部通过了，整合成功。



4.4、在web服务器中进行测试



1、编辑web.xml文件，添加spring监听器配置项，内容如下：



复制代码




xsi:schemaLocation="http://java.sun.com/xml/ns/javaee

http://java.sun.com/xml/ns/javaee/web-app_3_0.xsd"

version="3.0">



index.jsp







Spring监听器

org.springframework.web.context.ContextLoaderListener







contextConfigLocation



classpath:spring.xml,classpath:spring-mybatis.xml





复制代码

2、在UserMapper接口中添加一个获取所有用户信息的getAllUser()方法，如下所示：



复制代码

1packageme.gacl.dao;

2

3importjava.util.List;

4

5importme.gacl.domain.User;

6

7publicinterfaceUserMapper{

8intdeleteByPrimaryKey(StringuserId);

9

10intinsert(Userrecord);

11

12intinsertSelective(Userrecord);

13

14UserselectByPrimaryKey(StringuserId);

15

16intupdateByPrimaryKeySelective(Userrecord);

17

18intupdateByPrimaryKey(Userrecord);

19

20/获取所有用户信息

21@returnList

22/

23ListgetAllUser();

24}

复制代码

3、在UserMapper.xml文件中编写getAllUser()方法要执行的SQL语句，如下所示：



复制代码





















user_id,user_name,user_birthday,user_salary





select



fromt_user

whereuser_id=#{userId,jdbcType=CHAR}





deletefromt_user

whereuser_id=#{userId,jdbcType=CHAR}





insertintot_user(user_id,user_name,user_birthday,

user_salary)

values(#{userId,jdbcType=CHAR},#{userName,jdbcType=VARCHAR},#{userBirthday,jdbcType=DATE},

#{userSalary,jdbcType=DOUBLE})





insertintot_user





user_id,





user_name,





user_birthday,





user_salary,









#{userId,jdbcType=CHAR},





#{userName,jdbcType=VARCHAR},





#{userBirthday,jdbcType=DATE},





#{userSalary,jdbcType=DOUBLE},









updatet_user





user_name=#{userName,jdbcType=VARCHAR},





user_birthday=#{userBirthday,jdbcType=DATE},





user_salary=#{userSalary,jdbcType=DOUBLE},





whereuser_id=#{userId,jdbcType=CHAR}





updatet_user

setuser_name=#{userName,jdbcType=VARCHAR},

user_birthday=#{userBirthday,jdbcType=DATE},

user_salary=#{userSalary,jdbcType=DOUBLE}

whereuser_id=#{userId,jdbcType=CHAR}











selectuser_id,user_name,user_birthday,user_salaryfromt_user





复制代码

4、在UserServiceI接口中也添加一个getAllUser()方法，如下：



复制代码

1packageme.gacl.service;

2

3importjava.util.List;

4

5importme.gacl.domain.User;

6

7publicinterfaceUserServiceI{

8

9/

10添加用户

11@paramuser

12/

13voidaddUser(Useruser);

14

15/

16根据用户id获取用户

17@paramuserId

18@return

19/

20UsergetUserById(StringuserId);

21

22/获取所有用户信息

23@returnList

24/

25ListgetAllUser();

26}

复制代码

5、在UserServiceImpl类中实现getAllUser方法，如下：



复制代码

1packageme.gacl.service.impl;

2

3importjava.util.List;

4

5importorg.springframework.beans.factory.annotation.Autowired;

6importorg.springframework.stereotype.Service;

7importme.gacl.dao.UserMapper;

8importme.gacl.domain.User;

9importme.gacl.service.UserServiceI;

10

11/

12@authorgacl

13使用@Service注解将UserServiceImpl类标注为一个service

14service的id是userService

15/

16@Service("userService")

17publicclassUserServiceImplimplementsUserServiceI{

18

19/

20使用@Autowired注解标注userMapper变量，

21当需要使用UserMapper时，Spring就会自动注入UserMapper

22/

23@Autowired

24privateUserMapperuserMapper;//注入dao

25

26@Override

27publicvoidaddUser(Useruser){

28userMapper.insert(user);

29}

30

31@Override

32publicUsergetUserById(StringuserId){

33returnuserMapper.selectByPrimaryKey(userId);

34}

35

36@Override

37publicListgetAllUser(){

38returnuserMapper.getAllUser();

39}

40}

复制代码

6、在src/main/java目录下创建一个me.gacl.web.controller包，然后在me.gacl.web.controller下创建一个UserServlet，如下：



复制代码

1packageme.gacl.web.controller;

2

3importjava.io.IOException;

4importjava.util.List;

5

6importjavax.servlet.ServletException;

7importjavax.servlet.annotation.WebServlet;

8importjavax.servlet.http.HttpServlet;

9importjavax.servlet.http.HttpServletRequest;

10importjavax.servlet.http.HttpServletResponse;

11

12importorg.springframework.context.ApplicationContext;

13importorg.springframework.web.context.support.WebApplicationContextUtils;

14

15importme.gacl.domain.User;

16importme.gacl.service.UserServiceI;

17

18/

19@authorgacl

20@WebServlet是Servlet3.0提供的注解，目的是将一个继承了HttpServlet类的普通java类标注为一个Servlet

21UserServlet使用了@WebServlet标注之后，就不需要在web.xml中配置了

22/

23@WebServlet("/UserServlet")

24publicclassUserServletextendsHttpServlet{

25

26//处理业务逻辑的userService

27privateUserServiceIuserService;

28

29publicvoiddoGet(HttpServletRequestrequest,HttpServletResponseresponse)

30throwsServletException,IOException{

31//获取所有的用户信息

32ListlstUsers=userService.getAllUser();

33request.setAttribute("lstUsers",lstUsers);

34request.getRequestDispatcher("/index.jsp").forward(request,response);

35}

36

37publicvoiddoPost(HttpServletRequestrequest,HttpServletResponseresponse)

38throwsServletException,IOException{

39this.doGet(request,response);

40}

41

42publicvoidinit()throwsServletException{

43//在Servlet初始化时获取Spring上下文对象(ApplicationContext)

44ApplicationContextac=WebApplicationContextUtils.getWebApplicationContext(this.getServletContext());

45//从ApplicationContext中获取userService

46userService=(UserServiceI)ac.getBean("userService");

47}

48}

复制代码

7、编辑index.jsp页面，用于展示查询到的用户信息，内容如下：



复制代码

<%@pagelanguage="java"pageEncoding="UTF-8"%>

<%--引入JSTL核心标签库--%>

<%@taglibprefix="c"uri="http://java.sun.com/jsp/jstl/core"%>











table,td{

border:1pxsolid;

border-collapse:collapse;

}





















<%--遍历lstUsers集合中的User对象--%>

用户ID	用户名	用户生日	工资
${user.userId}	${user.userName}	${user.userBirthday}	${user.userSalary}

复制代码