Linux编译mybatis,Mybatis3.x与Spring4.x整合

最新推荐文章于 2024-07-15 14:12:51 发布

小宏i

最新推荐文章于 2024-07-15 14:12:51 发布

阅读量67

点赞数

文章标签： Linux编译mybatis

一、搭建开发环境

1.1、使用Maven创建Web项目

执行如下命令：

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

如下图所示：

创建好的项目如下：

编辑pom.xml文件

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

3 4.0.0

4 me.gacl

5 spring4-mybatis3

6 war

7 1.0-SNAPSHOT

8 spring4-mybatis3 Maven Webapp

9 http://maven.apache.org

12 junit

13 junit

14 3.8.1

15 test

19 spring4-mybatis3

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

另外，把以下内容删掉：

2 junit

3 junit

4 3.8.1

5 test

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

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

3 4.0.0

4 me.gacl

5 spring4-mybatis3

6 war

7 1.0-SNAPSHOT

8 spring4-mybatis3

9 http://maven.apache.org

14 spring4-mybatis3

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

具体操作步骤如下图所示：

手动创建【src/main/Java】、【src/test/resources】、【src/test/java】这三个source folder，如下图所示：

到此，项目搭建的工作就算是全部完成了。

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

SQL脚本如下：

Create DATABASEspring4_mybatis3;USEspring4_mybatis3;DROP TABLE IF EXISTSt_user;CREATE TABLEt_user (user_id char(32) NOT NULL,user_name varchar(30) DEFAULT NULL,

user_birthday dateDEFAULT NULL,

user_salarydouble DEFAULT NULL,PRIMARY KEY (user_id)

) ENGINE=InnoDB DEFAULT CHARSET=utf8;

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

三、使用generator工具生成代码

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

编辑generator.xml文件，内容如下：

1 <?xml version="1.0" encoding="UTF-8"?>

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

java -jar mybatis-generator-core-1.3.2.jar -configfile generator.xml -overwrite

如下图所示：

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

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

1、生成的dao类

1 packageme.gacl.dao;2

3 importme.gacl.domain.User;4

5 public interfaceUserMapper {6 intdeleteByPrimaryKey(String userId);7

8 intinsert(User record);9

10 intinsertSelective(User record);11

12 User selectByPrimaryKey(String userId);13

14 intupdateByPrimaryKeySelective(User record);15

16 intupdateByPrimaryKey(User record);17 }

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

2、生成的实体类

1 packageme.gacl.domain;2

3 importjava.util.Date;4

5 public classUser {6 privateString userId;7

8 privateString userName;9

10 privateDate userBirthday;11

12 privateDouble userSalary;13

14 publicString getUserId() {15 returnuserId;16 }17

18 public voidsetUserId(String userId) {19 this.userId = userId == null ? null: userId.trim();20 }21

22 publicString getUserName() {23 returnuserName;24 }25

26 public voidsetUserName(String userName) {27 this.userName = userName == null ? null: userName.trim();28 }29

30 publicDate getUserBirthday() {31 returnuserBirthday;32 }33

34 public voidsetUserBirthday(Date userBirthday) {35 this.userBirthday =userBirthday;36 }37

38 publicDouble getUserSalary() {39 returnuserSalary;40 }41

42 public voidsetUserSalary(Double userSalary) {43 this.userSalary =userSalary;44 }45 }

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

3、生成的SQL映射文件

1 <?xml version="1.0" encoding="UTF-8"?>

11 user_id, user_name, user_birthday, user_salary12

14 select15

16 from t_user17 where user_id = #{userId,jdbcType=CHAR}18

20 delete from t_user21 where user_id = #{userId,jdbcType=CHAR}22

24 insert into t_user (user_id, user_name, user_birthday,25 user_salary)26 values (#{userId,jdbcType=CHAR}, #{userName,jdbcType=VARCHAR}, #{userBirthday,jdbcType=DATE},27 #{userSalary,jdbcType=DOUBLE})28

30 insert into t_user31

33 user_id,34

36 user_name,37

39 user_birthday,40

42 user_salary,43

47 #{userId,jdbcType=CHAR},48

50 #{userName,jdbcType=VARCHAR},51

53 #{userBirthday,jdbcType=DATE},54

56 #{userSalary,jdbcType=DOUBLE},57

61 update t_user62

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

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

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

73 where user_id = #{userId,jdbcType=CHAR}74

76 update t_user77 set user_name = #{userName,jdbcType=VARCHAR},78 user_birthday = #{userBirthday,jdbcType=DATE},79 user_salary = #{userSalary,jdbcType=DOUBLE}80 where user_id = #{userId,jdbcType=CHAR}81

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文件中，如下所示：

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文件内容最终如下：

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

3 4.0.0

4 me.gacl

5 spring4-mybatis3

6 war

7 1.0-SNAPSHOT

8 spring4-mybatis3

9 http://maven.apache.org

13 org.springframework

14 spring-core

15 4.1.4.RELEASE

19 org.springframework

20 spring-context

21 4.1.4.RELEASE

25 org.springframework

26 spring-tx

27 4.1.4.RELEASE

31 org.springframework

32 spring-jdbc

33 4.1.4.RELEASE

37 org.springframework

38 spring-test

39 4.1.4.RELEASE

43 org.springframework

44 spring-web

45 4.1.4.RELEASE

49 org.aspectj

50 aspectjweaver

51 1.8.5

55 org.mybatis

56 mybatis

57 3.2.8

61 org.mybatis

62 mybatis-spring

63 1.2.2

67 javax.servlet

68 javax.servlet-api

69 3.0.1

72 javax.servlet.jsp

73 javax.servlet.jsp-api

74 2.3.2-b01

78 javax.servlet

79 jstl

80 1.2

84 mysql

85 mysql-connector-java

86 5.1.34

90 com.alibaba

91 druid

92 1.0.12

96 junit

97 junit

98 4.12

99 test

100

101

102

103 spring4-mybatis3

104

105

4.2、编写相关配置文件

1、dbconfig.properties

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

driverClassName=com.mysql.jdbc.Driver

validationQuery=SELECT 1

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的内容如下：

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的内容如下：

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

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

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

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

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

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

me.gacl.service.*

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

4.3、进行单元测试

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

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

1 packageme.gacl.service;2

3 importme.gacl.domain.User;4

5 public interfaceUserServiceI {6

7 /**

8 * 添加用户9 *@paramuser10 */

11 voidaddUser(User user);12

13 /**

14 * 根据用户id获取用户15 *@paramuserId16 *@return

17 */

18 User getUserById(String userId);19 }

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

1 packageme.gacl.service.impl;2

3 importorg.springframework.beans.factory.annotation.Autowired;4 importorg.springframework.stereotype.Service;5 importme.gacl.dao.UserMapper;6 importme.gacl.domain.User;7 importme.gacl.service.UserServiceI;8

9 /**

10 *@authorgacl11 * 使用@Service注解将UserServiceImpl类标注为一个service12 * service的id是userService13 */

14 @Service("userService")15 public class UserServiceImpl implementsUserServiceI {16

17 /**

18 * 使用@Autowired注解标注userMapper变量，19 * 当需要使用UserMapper时，Spring就会自动注入UserMapper20 */

21 @Autowired22 private UserMapper userMapper;//注入dao

24 @Override25 public voidaddUser(User user) {26 userMapper.insert(user);27 }28

29 @Override30 publicUser getUserById(String userId) {31 returnuserMapper.selectByPrimaryKey(userId);32 }33 }

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

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

1 packageme.gacl.test;2

3 importjava.util.Date;4 importjava.util.UUID;5 importme.gacl.domain.User;6 importme.gacl.service.UserServiceI;7 //import me.gacl.service.UserServiceI;

8 importorg.junit.Before;9 importorg.junit.Test;10 importorg.springframework.context.ApplicationContext;11 importorg.springframework.context.support.ClassPathXmlApplicationContext;12

13 public classMyBatisTest {14

15 privateUserServiceI userService;16

17 /**

18 * 这个before方法在所有的测试方法之前执行，并且只执行一次19 * 所有做Junit单元测试时一些初始化工作可以在这个方法里面进行20 * 比如在before方法里面初始化ApplicationContext和userService21 */

22 @Before23 public voidbefore(){24 //使用"spring.xml"和"spring-mybatis.xml"这两个配置文件创建Spring上下文

25 ApplicationContext ac = new ClassPathXmlApplicationContext(new String[]{"spring.xml","spring-mybatis.xml"});26 //从Spring容器中根据bean的id取出我们要使用的userService对象

27 userService = (UserServiceI) ac.getBean("userService");28 }29

30 @Test31 public voidtestAddUser(){32 //ApplicationContext ac = new ClassPathXmlApplicationContext(new String[]{"spring.xml","spring-mybatis.xml"});33 //UserServiceI userService = (UserServiceI) ac.getBean("userService");

34 User user = newUser();35 user.setUserId(UUID.randomUUID().toString().replaceAll("-", ""));36 user.setUserName("白虎神皇xdp");37 user.setUserBirthday(newDate());38 user.setUserSalary(10000D);39 userService.addUser(user);40 }41

42 }

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

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

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

编译结果如下：

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

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

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

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

1 packageme.gacl.test;2

3 importjava.util.Date;4 importjava.util.UUID;5 importme.gacl.domain.User;6 importme.gacl.service.UserServiceI;7 importorg.junit.Test;8 importorg.junit.runner.RunWith;9 importorg.springframework.beans.factory.annotation.Autowired;10 importorg.springframework.test.context.ContextConfiguration;11 importorg.springframework.test.context.junit4.SpringJUnit4ClassRunner;12

13 @RunWith(SpringJUnit4ClassRunner.class)14 //配置了@ContextConfiguration注解并使用该注解的locations属性指明spring和配置文件之后，

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

18 //注入userService

19 @Autowired20 privateUserServiceI userService;21

22 @Test23 public voidtestAddUser(){24 User user = newUser();25 user.setUserId(UUID.randomUUID().toString().replaceAll("-", ""));26 user.setUserName("xdp_gacl_白虎神皇");27 user.setUserBirthday(newDate());28 user.setUserSalary(10000D);29 userService.addUser(user);30 }31

32 @Test33 public voidtestGetUserById(){34 String userId = "fb1c5941094e400b975f10d9a9d602a3";35 User user =userService.getUserById(userId);36 System.out.println(user.getUserName());37 }38 }

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

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

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

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

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()方法，如下所示：

1 packageme.gacl.dao;2

3 importjava.util.List;4

5 importme.gacl.domain.User;6

7 public interfaceUserMapper {8 intdeleteByPrimaryKey(String userId);9

10 intinsert(User record);11

12 intinsertSelective(User record);13

14 User selectByPrimaryKey(String userId);15

16 intupdateByPrimaryKeySelective(User record);17

18 intupdateByPrimaryKey(User record);19

20 /**获取所有用户信息21 *@returnList22 */

23 ListgetAllUser();24 }

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

user_id, user_name, user_birthday, user_salary

selectfrom t_user

where user_id = #{userId,jdbcType=CHAR}

delete from t_user

where user_id = #{userId,jdbcType=CHAR}

insert into t_user (user_id, user_name, user_birthday,

user_salary)

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

#{userSalary,jdbcType=DOUBLE})

insert into t_user

user_id,

user_name,

user_birthday,

user_salary,

#{userId,jdbcType=CHAR},

#{userName,jdbcType=VARCHAR},

#{userBirthday,jdbcType=DATE},

#{userSalary,jdbcType=DOUBLE},

update t_user

user_name = #{userName,jdbcType=VARCHAR},

user_birthday = #{userBirthday,jdbcType=DATE},

user_salary = #{userSalary,jdbcType=DOUBLE},

where user_id = #{userId,jdbcType=CHAR}

update t_user

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

user_birthday = #{userBirthday,jdbcType=DATE},

user_salary = #{userSalary,jdbcType=DOUBLE}

where user_id = #{userId,jdbcType=CHAR}

select user_id, user_name, user_birthday, user_salary from t_user

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

1 packageme.gacl.service;2

3 importjava.util.List;4

5 importme.gacl.domain.User;6

7 public interfaceUserServiceI {8

9 /**

10 * 添加用户11 *@paramuser12 */

13 voidaddUser(User user);14

15 /**

16 * 根据用户id获取用户17 *@paramuserId18 *@return

19 */

20 User getUserById(String userId);21

22 /**获取所有用户信息23 *@returnList24 */

25 ListgetAllUser();26 }

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

1 packageme.gacl.service.impl;2

3 importjava.util.List;4

5 importorg.springframework.beans.factory.annotation.Autowired;6 importorg.springframework.stereotype.Service;7 importme.gacl.dao.UserMapper;8 importme.gacl.domain.User;9 importme.gacl.service.UserServiceI;10

11 /**

12 *@authorgacl13 * 使用@Service注解将UserServiceImpl类标注为一个service14 * service的id是userService15 */

16 @Service("userService")17 public class UserServiceImpl implementsUserServiceI {18

19 /**

20 * 使用@Autowired注解标注userMapper变量，21 * 当需要使用UserMapper时，Spring就会自动注入UserMapper22 */

23 @Autowired24 private UserMapper userMapper;//注入dao

26 @Override27 public voidaddUser(User user) {28 userMapper.insert(user);29 }30

31 @Override32 publicUser getUserById(String userId) {33 returnuserMapper.selectByPrimaryKey(userId);34 }35

36 @Override37 public ListgetAllUser() {38 returnuserMapper.getAllUser();39 }40 }

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

1 packageme.gacl.web.controller;2

3 importjava.io.IOException;4 importjava.util.List;5

6 importjavax.servlet.ServletException;7 importjavax.servlet.annotation.WebServlet;8 importjavax.servlet.http.HttpServlet;9 importjavax.servlet.http.HttpServletRequest;10 importjavax.servlet.http.HttpServletResponse;11

12 importorg.springframework.context.ApplicationContext;13 importorg.springframework.web.context.support.WebApplicationContextUtils;14

15 importme.gacl.domain.User;16 importme.gacl.service.UserServiceI;17

18 /**

19 *@authorgacl20 * @WebServlet是Servlet3.0提供的注解，目的是将一个继承了HttpServlet类的普通java类标注为一个Servlet21 * UserServlet使用了@WebServlet标注之后，就不需要在web.xml中配置了22 */

23 @WebServlet("/UserServlet")24 public class UserServlet extendsHttpServlet {25

26 //处理业务逻辑的userService

27 privateUserServiceI userService;28

29 public voiddoGet(HttpServletRequest request, HttpServletResponse response)30 throwsServletException, IOException {31 //获取所有的用户信息

32 List lstUsers =userService.getAllUser();33 request.setAttribute("lstUsers", lstUsers);34 request.getRequestDispatcher("/index.jsp").forward(request, response);35 }36

37 public voiddoPost(HttpServletRequest request, HttpServletResponse response)38 throwsServletException, IOException {39 this.doGet(request, response);40 }41

42 public void init() throwsServletException {43 //在Servlet初始化时获取Spring上下文对象(ApplicationContext)

44 ApplicationContext ac = WebApplicationContextUtils.getWebApplicationContext(this.getServletContext());45 //从ApplicationContext中获取userService

46 userService = (UserServiceI) ac.getBean("userService");47 }48 }

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

显示用户信息

table,td{border:1px solid;border-collapse:collapse;

}

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

8、执行maven install命令编译项目，然后将项目部署到tomcat服务器中运行，注意，由于要使用Servlet3.0，所以必须将项目部署到tomcat7.x以上的服务器中去运行，如下所示：

输入地址：http://localhost:8080/spring4-mybatis3/UserServlet 访问UserServlet，访问结果如下：

可以看到，t_user表中的用户信息全部查询出来显示到页面上了。这样在web服务器中的测试也正常通过了。

以上就是Spring4.x与MyBatis3.x整合的全部内容了。编写这个整合例子花了不少时间，使用Maven编译时总是出现莫名其妙的问题，有时候成功，有时候失败，反正很莫名其妙。如果遇到执行Maven install操作不能正常编译通过的情况：可以尝试采用：Maven clean→Clean项目→Maven install这三个步骤去解决问题。

MyBatis 的详细介绍：请点这里

MyBatis 的下载地址：请点这里