Java系列--第一篇 Maven+Spring+Spring MVC+mybatis 示例
基于Maven的Spring+SpringMVC+Mybatis的一个小项目的搭建,由于使用Maven3.1.0管理,所以Spring等都将使用的是时下(2013/9/8)最新的版本。即从http://search.maven.org/ 得到最新的POM文件。
以下是我的一步一步实现步骤:
1, cmd 下面输入
mvn archetype:generate -DgroupId=com.vanceinfo.javaserial -DartifactId=ssme -DarchetypeArtifactId=maven-archetype-webapp -DpackageName=com.vanceinfo.javaserial
2,Kepler中导入已存在的maven 项目,却发现没有src/main/java 和src/test/java两个source folder,只有一个src/main/resources source folder. 要解决这个问题,只需要项目属性中改一下System library就可以看到了。如图示
3,接下来,由于我们要使用Spring 和mybatis,所以我们需要引用相关的依赖进POM.xml文件里面。为保持时下的最新性,首先进入search.maven.org里面,搜索spring-core,得到最新版本号为3.2.4.RELEASE,所以复制如下pom至pom.xml 文件。
<dependency> <groupId>org.springframework</groupId> <artifactId>spring-core</artifactId> <version>3.2.4.RELEASE</version> </dependency>
保存之后,注意观察Eclipse 上面的Maven Dependencies里面自动加上了commons-logging-1.1.1.jar,也就是说你需要使用什么Jar,直接引用该Jar即可,无需顾虑其依赖的Jar,其依赖的Jar,Maven会自动加载上去的。这也是Maven的一大引人注目的亮点。
当然,作为时下最新的版本,要使用Spring,还需要引用spring-context的。
<dependency> <groupId>org.springframework</groupId> <artifactId>spring-context</artifactId> <version>3.2.4.RELEASE</version> </dependency>
经实验,实际上还需要spirng-tx的。
<dependency> <groupId>org.springframework</groupId> <artifactId>spring-tx</artifactId> <version>3.2.4.RELEASE</version> </dependency>
以及spring-jdbc
<dependency> <groupId>org.springframework</groupId> <artifactId>spring-jdbc</artifactId> <version>3.2.4.RELEASE</version> </dependency>
4, 继续引入mybatis
<dependency> <groupId>org.mybatis</groupId> <artifactId>mybatis</artifactId> <version>3.2.2</version> </dependency>
以及mybatis和spring之间的沟通mybatis-spring1.2.0
<dependency> <groupId>org.mybatis</groupId> <artifactId>mybatis-spring</artifactId> <version>1.2.0</version> </dependency>
5, 引入了mybatis,自然会有关系型数据库的驱动包,这里我选用mysql数据库,所以要引入mysql-connector-java5.1.26
<dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>5.1.26</version> </dependency>
顺带改一下junit的版本,因为我从maven.org里看到最新的junit是4.11,所以用最时下最新的,改完之后,发现eclipse自动引用了hamcrest-core-1.3.jar
6, 接下来在mysql中创建一个表user,用mysqlworkbench打开。为演示方便,我直接使用了test数据库,创建了一个只有3个字段的user表,并且只输入了两条数据。
7, 使用mybatis generator(MBG) 工具生成dao,mapping和model,使用的generator.xml如下:
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE generatorConfiguration PUBLIC "-//mybatis.org//DTD MyBatis Generator Configuration 1.0//EN" "http://mybatis.org/dtd/mybatis-generator-config_1_0.dtd"> <generatorConfiguration> <!-- 数据库驱动包位置 --> <classPathEntry location="C:\Users\Administrator\.m2\repository\mysql\mysql-connector-java\5.1.26\mysql-connector-java-5.1.26.jar" /> <context id="DB2Tables" targetRuntime="MyBatis3"> <commentGenerator> <property name="suppressAllComments" value="true" /> </commentGenerator> <!-- 数据库链接URL、用户名、密码 --> <jdbcConnection driverClass="com.mysql.jdbc.Driver" connectionURL="jdbc:mysql://localhost:3306/test"> </jdbcConnection> <javaTypeResolver> <property name="forceBigDecimals" value="false" /> </javaTypeResolver> <!-- 生成模型的包名和位置 --> <javaModelGenerator targetPackage="com.vanceinfo.javaserial.model" targetProject="E:\Java\mybatis-generator-core-1.3.2\lib\src"> <property name="enableSubPackages" value="true" /> <property name="trimStrings" value="true" /> </javaModelGenerator> <!-- 生成的映射文件包名和位置 --> <sqlMapGenerator targetPackage="com.vanceinfo.javaserial.mapping" targetProject="E:\Java\mybatis-generator-core-1.3.2\lib\src"> <property name="enableSubPackages" value="true" /> </sqlMapGenerator> <!-- 生成DAO的包名和位置 --> <javaClientGenerator type="XMLMAPPER" targetPackage="com.vanceinfo.javaserial.dao" targetProject="E:\Java\mybatis-generator-core-1.3.2\lib\src"> <property name="enableSubPackages" value="true" /> </javaClientGenerator> <!-- 要生成那些表(更改tableName和domainObjectName就可以) --> <table tableName="user" domainObjectName="User" enableCountByExample="false" enableUpdateByExample="false" enableDeleteByExample="false" enableSelectByExample="false" selectByExampleQueryId="false" /> </context> </generatorConfiguration>
然后创建一个MBG_HOME的环境变量和一个mbg.cmd的文件,该cmd内容如下:
java -jar %MBG_HOME%\lib\mybatis-generator-core-1.3.2.jar -configfile %MBG_HOME%\lib\generator.xml -overwrite
cmd中运行mbg就会分别生成dao,mapping,model,将这三个文件夹复制至java下面,然后刷新eclipse里面的方案,即可。
8, 接下来就是Java的代码编写了,主要是service 和 controller的编写,极其简单:
public interface IUserService { public User getUserById(int id); } @Service("userService") public class UserServiceImpl implements IUserService { private UserMapper userMapper; public UserMapper getUserMapper() { return userMapper; } @Autowired public void setUserMapper(UserMapper userMapper) { this.userMapper = userMapper; } @Override public User getUserById(int id) { return userMapper.selectByPrimaryKey(id); } }
@Controller @RequestMapping("/userController") public class UserController { private IUserService userService; public IUserService getUserService() { return userService; } @Autowired public void setUserService(IUserService userService) { this.userService = userService; } @RequestMapping("/{id}/index") public String showUser(@PathVariable int id, HttpServletRequest request) { User u = userService.getUserById(id); request.setAttribute("user", u); return "index"; } }
您也可以从随后的附件下载中查阅完整代码,实现后的代码结构如下所示:
作为Maven管理的项目,src/main/resource就是那个classpath的根目录了,而且还需要注意一点就是mvn打包时不会把src/main/java source folder下面的.xml之类的文件包进war包的,解决方案是在pom中手动加上resource节点,结构是
<build>
<resources>
<resource>
<directory>src/main/java<directory>
<includes>
<include>*.xml</include>
.. ..
</includes>
</resource>
.......
</resources>
</build>
9, 使用mvn clean install就会在target下面生成一个叫ssme.war的文件,将该文件复制进tomcat的webapps文件下面,启动tomcat. 启动mysqld,然后在浏览器上面敲入 http://localhost:8080/ssme/userController/1/index.do,应该就可以看到:
10, Trouble shouting, 要学会看log,尤其是tomcat启动时,如果有错就会有各种错误日志出来,学会从这些日志里找出根源,然后处理,上面为了出现那简短的两个字段,我还真是重新启动了好几次tomcat7才搞定的。一般都是少了pom引用。列举一些如下:
SEVERE: Context initialization failed org.springframework.beans.factory.parsing.BeanDefinitionParsingException: Config uration problem: Unable to locate Spring NamespaceHandler for XML schema namespa ce [http://www.springframework.org/schema/tx] Offending resource: class path resource [spring-mybatis.xml]
org.springframework.beans.factory.CannotLoadBeanClassException: Cannot find clas s [org.springframework.jdbc.datasource.DataSourceTransactionManager] for bean wi th name 'transactionManager' defined in class path resource [spring-mybatis.xml] ; nested exception is java.lang.ClassNotFoundException: org.springframework.jdbc .datasource.DataSourceTransactionManager
<build>
<finalName>ssme</finalName>
<resources>
<resource>
<directory>src/main/java</directory>
<includes>
<include>**/*.xml </include>
</includes>
</resource>
<resource>
<directory>src/main/resources</directory>
<includes>
<include>*.xml </include>
<include>*.properties </include>
</includes>
</resource>
<resource>
<directory>src/main/webapp/WEB-INF</directory>
<includes>
<include>*.xml </include>
<include>*.properties </include>
</includes>
</resource>
</resources>
</build>
11,接下来我们还引入log4j这个组件来,首先当然是在pom中加入:
<dependency> <groupId>log4j</groupId> <artifactId>log4j</artifactId> <version>1.2.17</version> </dependency>
接着在需要写日志的java源文件中定义private static final Logger logger = Logger.getLogger(XXXXXX.class);
然后在log4j.properties中输入, 这个基本上没有什么改变的,要改的就是log4j.appender.File.File=ssme.log,改成自己的项目名或其它你喜欢的名字即可。
log4j.rootLogger=DEBUG,Console,File log4j.appender.Console=org.apache.log4j.ConsoleAppender log4j.appender.Console.Target=System.out log4j.appender.Console.layout=org.apache.log4j.PatternLayout log4j.appender.Console.layout.ConversionPattern=[%c]%m%n log4j.appender.File=org.apache.log4j.RollingFileAppender log4j.appender.File.File=ssme.log log4j.appender.File.MaxFileSize=10MB log4j.appender.File.Threshold=ALL log4j.appender.File.layout=org.apache.log4j.PatternLayout log4j.appender.File.layout.ConversionPattern=[%p][%d{yyyy-MM-dd HH\:mm\:ss,SSS}][%c]%m%n
12, 单元测试,由于本次主要是找spring 和mybatis的整合,所以只对userService时进行了一下单元测试,其余的象controller之类的,暂没有列入。其实本人公司 要求使用Parameter集成测试。以后找个理由来讨论一下这个参数化单元测试。代码比较简单,所以您可以打开在线查看一下
@RunWith(SpringJUnit4ClassRunner.class) @ContextConfiguration(locations = { "classpath:spring.xml", "classpath:spring-mybatis.xml" }) public class UserServiceImplTest { private static final Logger logger = Logger.getLogger(UserServiceImplTest.class); private IUserService userService; public IUserService getUserSerivce() { return userService; } @Autowired public void setUserSerivce(IUserService userSerivce) { this.userService = userSerivce; } @Test public void getUserByIdtest() { User u = userService.getUserById(1); logger.info(JSON.toJSONStringWithDateFormat(u, "yyyy-MM-dd HH:mm:ss")); } }
由于使用了log4j来查看取回来的User 数据,同时为了查看方便,再次引用阿里巴巴的温少的fastjson,利用该组件,我们将看到返回的信息是
{"email":"jin@163.com","id":1,"name":"nate"}
结果正确,所以讲解一下上面这段代码如何正确运行。引入以下两个pom
<dependency> <groupId>com.alibaba</groupId> <artifactId>fastjson</artifactId> <version>1.1.36</version> </dependency>
<dependency> <groupId>org.springframework</groupId> <artifactId>spring-test</artifactId> <version>3.2.4.RELEASE</version> </dependency>
本文参考学习地址包括但不限于http://bbs.jeasyuicn.com/forum.php?mod=viewthread&tid=818&extra=page%3D1,最后附上完整项目源码供您下载。