SSM框架详细整合
介绍
Spring + SpringMVC + Mybatis是现在轻量级J2EE框架方案中,非常流行的架构。
笔记以创建Maven项目、搭建DAO层+Mybatis、Mybatis与Spring结合、SpringMVC与Spring的结合 为主线索开始搭建SSM框架项目。 最后实现对MySQL中数据的增删改查。
使用Maven 创建项目的空架子架子
首先 检查一下maven是否配置正确
cmd:
mvn -v
如果返回mvn相关的版本和配置信息,则mvn配置正确。
如果没有安装maven 这里简要的介绍一下安装方法:
- 去官网下载maven的文件包
2.将下载后的maven解压到硬盘合适的位置
3.windows系统设置环境变量,增加MAVEN_HOME =maven位置,在PATH中加入maven/bin的位置
4(可选).修改maven本地仓库的位置.找到 apache-maven-XXX下的 conf 下的 settings.xml 配置文件,修改标签内容。
5.修改maven镜像,由于国内网络环境的问题,maven默认的镜像会很慢,这里可以改为国内镜像。在配置文件中的标签加入如下的阿里镜像:
nexus-aliyun
*
Nexus aliyun
http://maven.aliyun.com/nexus/content/groups/public
在想要创建工程的目录的位置 cmd 输入创建maven项目的指令如下:
mvn archetype:generate -DgroupId=项目BundleID(例如:com.name) -DartifactId=项目名称 -DarchetypeArtifactId=maven-archetype-webapp
以上,使用maven的 webapp模板搭建一个项目框架。注意:老版本的maven archetype是:create 而不是generate!!!
创建完的工程目录结构如下:
使用IDE导入maven项目,修改配置,添加依赖
这里的ide以IndelliJ IDEA为例
打开IDE-file-open 然后找到刚才工程的pom.xml文件,打开 注意这里打开pom文件而不是工程文件夹
修改web.xml
接下来需要修改web.xml文件,因为maven自动创建的web.xml文件servlet的版本是2.3 ,这个版本jsp默认的el表达式是不工作的,需要替换成更高的。
我们找到Tomcat自带的example的web.xml。Tomcat默认的路径是:
Apache Software Foundation\Tomcat 7.0_Tomcat7ForEclipse\webapps\examples\WEB-INF\web.xml
复制xml的头,修改到工程的web.xml文件,修改后的文件如下:
添加目录
IDE 中:Project Setting-Modules,增加Source和test(单元测试)目录的source和resource文件
注意添加相应的目录后要设置其成为Source或者Resources 目录如下图:
修改pom.xml添加项目依赖
依赖主要分为四大部分:
- 日志
- 数据库相关
- Servlet Web相关
- Spring
配置好的pom.xml 文件如下:
4.0.0
org.seckill
seckill
war
1.0-SNAPSHOT
seckill Maven Webapp
http://maven.apache.org
junit
junit
4.11
test
org.slf4j
slf4j-api
1.7.12
ch.qos.logback
logback-core
1.1.1
ch.qos.logback
logback-classic
1.1.1
mysql
mysql-connector-java
5.1.35
runtime
c3p0
c3p0
0.9.1.2
org.mybatis
mybatis
3.3.0
org.mybatis
mybatis-spring
1.2.3
taglibs
standard
1.1.2
jstl
jstl
1.2
com.fasterxml.jackson.core
jackson-databind
2.5.4
javax.servlet
javax.servlet-api
3.1.0
org.springframework
spring-core
4.1.7.RELEASE
org.springframework
spring-beans
4.1.7.RELEASE
org.springframework
spring-context
4.1.7.RELEASE
org.springframework
spring-jdbc
4.1.7.RELEASE
org.springframework
spring-tx
4.1.7.RELEASE
org.springframework
spring-web
4.1.7.RELEASE
org.springframework
spring-webmvc
4.1.7.RELEASE
org.springframework
spring-test
4.1.7.RELEASE
seckill
Tip 使用Intellj Idea IDE的ctrl+alt+L快捷键可以自动调整代码格式
DAO层的配置(数据库、Mybatis)
为了以后的测试首先建一个数据库,做一个测试用的表:user_t
创建表的脚本如下:
CREATE TABLE `user_base` (
`id` INT(11) NOT NULL AUTO_INCREMENT,
`user_name` VARCHAR(40) NOT NULL,
`password` VARCHAR(255) NOT NULL,
`age` INT(4) NOT NULL,
PRIMARY KEY (`id`)
) ENGINE=INNODB AUTO_INCREMENT=2 DEFAULT CHARSET=utf8
表大概长这个样子:
写接口
在工程目录中java创建接口包:com.example这个包又包括两个子包entity和dao
创建表对应的entity
在entity目录下创建 userBase 的entity,UserBase.java
package com.example.entity;
public class UserBase {
private long id;
private String name;
private String password;
private int age;
public long getId() {
return id;
}
public void setId(long id) {
this.id = id;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public String getPassword() {
return password;
}
public void setPassword(String password) {
this.password = password;
}
public int getAge() {
return age;
}
public void setAge(int age) {
this.age = age;
}
@Override
//为了以后测试方便,增加toString的打印方法
public String toString() {
return "UserBase{" +
"id=" + id +
", name='" + name + '\'' +
", password='" + password + '\'' +
", age=" + age +
'}';
}
}
创建DAO 接口
dao文件一般按照对应的entity+Dao的命名规则
在dao目录下新建UserBaseDao.java
注意这里创建的Dao是个接口 interface,现在不用实现
package com.example.dao;
import com.example.entity.UserBase;
import java.util.List;
public interface UserBaseDao {
/*
增加用户
*/
int createUser (UserBase userBase);
/*
更改某id的用户信息
*/
int updateUserById (long id);
/*
查询所有用户信息
*/
List queryAllUser ();
/*
删除某id的用户
*/
int delateUserById(long id);
}
现在的项目目录结构如下:
用Mybatis实现DAO接口
实现DAO有两种方法:
- XML提供SQL
- 注解提供SQL
XML提供SQL的方式最灵活,也可以通过高级的SQL技巧实现接口的性能优化,故用XML方式
MyBatis通过mapper映射机制实现DAO
在resources目录创建一个全局的Mybatis配置文件:mybatis-config.xml
从mybatis官网上找到全局配置文件的标准例子,包文件头复制过来,然后开始配置xml文件如下:
使用mapper方式实现Dao接口
在resources下创建一个目录来存放不同的mapper
新建一个UserBase.xml文件
在Mybatis官网上找到mapper的示例,复制xml文件头,一个空的mapper文件应该如下:
注意mapper的文件名和对应实现的Dao的文件名最好一样,方便Mybatis或者Spring的的自动扫描机制识别!
接下来要在Mapper中设置namespace来告诉mapper实现哪个Dao,在mapper标签中 加入namespace属性:
这样,UserBase.xml和UserBase.java文件的映射关系就建立了。
为Dao接口的方法提供SQL语句配置
在mapper文件中一次实现Dao接口中方法的sql,id需要和Dao接口的方法名完全一致,如下:
INSERT IGNORE INTO user_base(
id,
user_name,
PASSWORD,
age
)
VALUES(
#{id},
#{name},
#{password},
#{age}
)
注意,parameterType和parameterMap的区别,传入单个参数的时候用parameterType,传入多个参数的时候用ParameterMap
目前的项目目录架构如下:
MyBatis整合Spring
首先在resources目录下创建spring目录用来存放spring配置文件。在这个目录新建一个sprng-dao.xml文件。
在spring官方文档中找到示例配置
趋势:约定大于配置和->节省配置文件配置
另外,需要想配置文件中描述的那样在resource目录下新建jdbc.properties数据库配置文件:
jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/ssm?useUnicode=true&characterEncoding=UTF-8&allowMultiQueries=true
jdbc.username=root
jdbc.password=apple
使用JUnit 进行接口测试
进入UserBaseDao类,选中类的名字然后使用快捷键Ctrl+shift+t,选择Create Unit Test,选择JUnit4,然后选中所有接口,创建测试类,在test/java目录下会生成测试类文件,如下图:
在测试类中需要配置Spring和JUnit整合的相关注解,这样JUnit启动的时候会加载Spring,而Spring又整合了Mybatis,从而实现了JUnit和Spring、MyBatis的整合。
由于之前只实现了createUser接口,我们只对该接口进行单元测试,测试之前不要忘记打开MySQL数据库服务。
package com.example.dao;
import com.example.entity.UserBase;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringJUnit4ClassRunner;
import javax.annotation.Resource;
import static org.junit.Assert.*;
/*
* 配置spring和junit整合,junit启动时加载springIOC容器
* spring-test,junit
*/
@RunWith(SpringJUnit4ClassRunner.class)
//告诉junit spring配置文件
@ContextConfiguration({"classpath:spring/spring-dao.xml"})
public class UserBaseDaoTest {
//注入Dao实现依赖
@Resource //注入dao实现
private UserBaseDao userBaseDao;
@Test
public void createUser() throws Exception {
UserBase user = new UserBase();
user.setId(7);
user.setAge(18);
user.setName("C罗");
user.setPassword("520cluo");
int insertUser = userBaseDao.createUser(user);
System.out.println(insertUser);
}
@Test
public void updateUserById() throws Exception {
}
@Test
public void queryAllUser() throws Exception {
}
@Test
public void delateUserById() throws Exception {
}
}
去数据库里看看是否有新的用户被插入了:
说明我们的Dao层配置的正确
Service层
首先新建Service文件目录:
- service 存放service类
- exception 存放异常
- dto 数据传输类,与entity类似,entity是业务数据实体,而dto更关注web和service(客户端和服务端)之间的数据传递。
在service目录下,新建UserBaseService 的接口类。然后在service目录下简历impl包,来存放Service接口的实现,并新建UserBaseServiceImpl类,利用IDE快捷键,实现UserBaseService接口里的方法。注意有的时候IDE当写接口实现使用@Override注解的时候,会报错,尝试修改File--Project Structure ---->Project--->project language level和 File--Project Structure ---->Module--->project language level调整到较高的版本即可(6或以上)。
接下来 在接口中定义所要用到的Dao和Logger。然后开始实现接口。
public class UserBaseServiceImpl implements UserBaseService {
private UserBaseDao userBaseDao;//在Spring容器中已实例化
private org.slf4j.Logger logger = LoggerFactory.getLogger(this.getClass());
@Override
public int createUser(UserBase user) {
return userBaseDao.createUser(user);
}
}
利用Spring IOC 获取类的实现
Spring IOC提供了多种依赖注入的方式
- XML:Bean来自第三方类库;需要命名空间比如context、aop、mvc等
- 注解:项目自身开发使用的类,可以直接在代码中适用注解比如@Service、@Controller
- Java配置类:需要代码控制对象创建的逻辑场景例如自定义修改依赖库(不常用)
在这个项目中使用了xml配置方式、package-scan包扫描和注解方式。
在Resource-spring目录下创建一个spring-service.xml文件。在配置文件中生命包扫描。如下
接下来,在Service中加入关于注解的配置,注解有多种:
- @Component:代表所有组件,当不知道是具体什么组件的时候用
- @Service
- @Dao
- @Controller
在当前案例,在Service类前面加入@Service注解
@Service
public class UserBaseServiceImpl implements UserBaseService {
因为Dao使用Mybatis注入,需要加入注解@Autowired让Spring在容器中搜索并获得实例
@Autowired
private UserBaseDao userBaseDao;//在Spring容器中已实例化
到此,Service的配置完成。
Spring声明事务
声明式事务的介绍:
Spring 事务声明方式的演化:
- 2.0:ProxyFactoryBean+XML
- 永久生效:tx:advice-aop命名空间(例如声明所有以update开头的方法都是事务方法)
- 注解@Transaction
事务方法的嵌套
略
什么时候回滚事务
抛出运行期异常(RuntimeException)
配置声明事务
在spring-service.xml文件中加入事务配置,注意xml头的导入:
在Service方法中加入注解控制事务:
在方法上加入@Transactional注解和throws RuntimeException异常抛出声明
整合SpringMvc
首先对web.xml文件进行修改,加入SpringMvc请求分发等机制
demo-dispatcher
org.springframework.web.servlet.DispatcherServlet
contextConfigLocation
classpath:spring/spring-*.xml
demo-dispatcher
/
web.xml文件中,对servlet和SpringMVC的配置,接下来对SpringMVC自身进行配置,在spring目录下新建springmvc-web.xml文件。从别的spring配置文件中拷贝文件头。
以上配置文件就配置完成了
至此,项目的结构如下:
开发接口Controller
首先在dao、service同一目录下新建web目录,用来存放controller。然后新建UserController类,通过注解@Controller声明此类是Controller,然后通过一些列的注解引入server实例,和请求的方式等
package com.example.web;
import com.example.service.UserBaseService;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
import javax.servlet.http.HttpServletRequest;
@Controller
public class UserController {
private static final Logger logger = (Logger) LoggerFactory.getLogger(UserController.class);
@Autowired
private UserBaseService userBaseService;
@RequestMapping(value="/user/allUser",produces="text/html;charset=UTF-8")
@ResponseBody
public String allUser(HttpServletRequest request) {
return userBaseService.queryAllUser().toString();
}
}
接下来就可以测试接口了。
首先配置Tomcat容器,选中项目然后选择菜单栏的Run-Edit Configurations
在server标签选择如下的Tomcat配置
然后选择Department标签,将项目部署到Tomcat
接下来就可以在Tomcat上跑服务了
如果报Compile的错,需要到File-Setting中修改编译版本如下图:
测试接口如下: