以项目驱动学习,以实践检验真知
现在使用Java后端开发使用的技术栈基本上比较统一:Spring + SpringMVC + Mybatis,即大家常说的SSM。虽然现在流行的做法是使用SpringBoot来快速搭建、配置好SSM项目,但还是有必要知道如何不用SpringBoot来组合好这三者,因为SpringBoot也只是帮助我们做好了许多配置,并不是说舍弃掉了那些配置,所以知道原生的SSM如何整合可以更好帮助我们理解SSM也能更好的理解SpringBoot带来的好处!而且有的老项目就是没有用SpringBoot,如果你对原生SSM整合与配置一无所知那维护老项目起来会极其难受。
SSM整合相比起SpringBoot的快速搭建自然是繁琐无比,但是不用担心,本文会一步一步演示如何整合这三者,并且会讲解每个配置的含义。老套路,文章最后还放上了思维导图和项目Github地址,clone下来即可直接运行,如果想自己做一个完整的SSM项目,直接用这套架子进行开发也是完全没问题的!
这里使用idea进行项目创建,maven来管理依赖包。首先我们在idea上新建一个project,选择Maven,然后选择web应用:
点击下一步后输入GroupId和ArtifactId后点击下一步直到完成。项目创建完毕后整个项目结构如下:
现在还先别着急配置SSM,我们先得配置一下这个idea下的web项目才行。大家也可以看到,项目建立起来后这个web.xml文件里写的是2.3版本,这个版本太老了,不行。
我们按住catl + shift + alt + S
打开idea的Project Structure,然后点击左侧的Modules,再点击Web,然后点击右边的删除按钮,确定,最后点击APPLY先将这个默认的删除:
此时我们会发现默认的web.xml文件已经被删除了。然后我们再点击右侧的添加按钮,点击web.xml进行添加:
这里我们选择3.1版本,选择好后点击弹出框的OK,再点击下方的OK即可创建完毕:
创建完毕后就会发现我们的web.xml内容已经变成了3.1了。
此时还先不要着急去配置SSM,我们现在项目连个基本的结构都没有呢,你核心代码写在哪,你测试在哪些,你资源放哪这些都是我们要去建立的。
首先,我们在src路径下新建test文件夹,然后在src/main路径下新建java和resources文件夹。建立好文件夹后,右键点击文件夹,然后拖到下方,选择Mark Directory as,然后选择对应的目录结构。
java文件夹对应SourcesRoot,代表标记为项目源代码路径,代码就写在这里。
resources文件夹对应ResourcesRoot,代表标记为资源路径,所有资源比如配置文件就放在这。
test文件夹对应TestSourcesRoot,代表标记为测试路径,测试代码都会放在这里。
文件夹指定好后,我们就要在java文件夹下创建我们的代码包结构。包的话就分为最基本的controller、service、mapper、entity。包建好后目录结构如下:
基本的项目结构整理好后,接下来我们就要开始对SSM进行整合了。首先肯定要做的就是在pom.xml文件中导入必备的依赖包,直接复制粘贴就好了,各个地方都做了注释说明:
<properties>
<project.build.sourceEncoding>UTF-8project.build.sourceEncoding>
<maven.compiler.source>1.8maven.compiler.source>
<maven.compiler.target>1.8maven.compiler.target>
<mysql.version>5.1.48mysql.version>
<spring.version>5.2.0.RELEASEspring.version>
<jackson.version>2.10.0jackson.version>
properties>
<dependencies>
<dependency>
<groupId>junitgroupId>
<artifactId>junitartifactId>
<version>4.12version>
<scope>testscope>
dependency>
<dependency>
<groupId>ch.qos.logbackgroupId>
<artifactId>logback-classicartifactId>
<version>1.2.3version>
dependency>
<dependency>
<groupId>org.projectlombokgroupId>
<artifactId>lombokartifactId>
<version>1.18.10version>
<scope>providedscope>
dependency>
<dependency>
<groupId>mysqlgroupId>
<artifactId>mysql-connector-javaartifactId>
<version>${mysql.version}version>
dependency>
<dependency>
<groupId>com.alibabagroupId>
<artifactId>druidartifactId>
<version>1.1.12version>
dependency>
<dependency>
<groupId>org.mybatisgroupId>
<artifactId>mybatisartifactId>
<version>3.4.6version>
dependency>
<dependency>
<groupId>javaxgroupId>
<artifactId>javaee-apiartifactId>
<version>8.0version>
<scope>providedscope>
dependency>
<dependency>
<groupId>javax.servletgroupId>
<artifactId>jstlartifactId>
<version>1.2version>
dependency>
<dependency>
<groupId>com.fasterxml.jackson.coregroupId>
<artifactId>jackson-coreartifactId>
<version>${jackson.version}version>
dependency>
<dependency>
<groupId>com.fasterxml.jackson.coregroupId>
<artifactId>jackson-databindartifactId>
<version>${jackson.version}version>
dependency>
<dependency>
<groupId>com.fasterxml.jackson.coregroupId>
<artifactId>jackson-annotationsartifactId>
<version>${jackson.version}version>
dependency>
<dependency>
<groupId>org.springframeworkgroupId>
<artifactId>spring-jdbcartifactId>
<version>${spring.version}version>
dependency>
<dependency>
<groupId>org.springframeworkgroupId>
<artifactId>spring-contextartifactId>
<version>${spring.version}version>
dependency>
<dependency>
<groupId>org.springframeworkgroupId>
<artifactId>spring-webmvcartifactId>
<version>${spring.version}version>
dependency>
<dependency>
<groupId>org.aspectjgroupId>
<artifactId>aspectjweaverartifactId>
<version>1.9.4version>
dependency>
<dependency>
<groupId>org.springframeworkgroupId>
<artifactId>spring-testartifactId>
<version>${spring.version}version>
<scope>testscope>
dependency>
<dependency>
<groupId>org.mybatisgroupId>
<artifactId>mybatis-springartifactId>
<version>1.3.2version>
dependency>
dependencies>
在进行整合之前我们来准备一下数据库,好接下来进行一个完整的演示。我这里用的是MySQL 5.7.25,咱们建立一个名为ssm_demo的数据库,执行语句新建一张user表并插入两条测试数据:
CREATE TABLE `user` (
`id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT '主键id',
`name` varchar(255) COLLATE utf8mb4_bin NOT NULL COMMENT '账户名',
`password` varchar(255) COLLATE utf8mb4_bin NOT NULL COMMENT '账户密码',
PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=utf8mb4 COLLATE=utf8mb4_bin;
INSERT INTO `user` VALUES (1, 'admin', '123456');
INSERT INTO `user` VALUES (2, 'rudecrab', '654321');
然后我们在entity包下建立和数据库表对应的实体类User:
@Data // lombok注解,自动生成Getter、Setter、toString方法
public class User implements Serializable {
private Long id;
private String name;
private String password;
}
然后我们在resources文件夹下建立database.properties
文件来配置数据库连接的相关信息(这里根据自己的数据库信息配置哦),等下整合Mybatis要用到的:
jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://127.0.0.1:3306/ssm_demo?characterEncoding=utf-8&useSSL=false&autoReconnect=true&rewriteBatchedStatements=true&serverTimezone=UTC
jdbc.username=root
jdbc.password=root
真实项目中一般是要观察日志输出的,我们再配置一下日志。在resources目录下新建logback.xml
文件。注意啊,在尾部需要指定某个包,这个根据自己项目结构包名来设置:
<configuration>
<property name="LOG_ERROR_HOME" value="error"/>
<property name="LOG_INFO_HOME" value="info"/>
<appender name="CONSOLE_LOG" class="ch.qos.logback.core.ConsoleAppender">
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<pattern>%red(%d{yyyy-MM-dd HH:mm:ss.SSS}) %yellow([%-5p]) %highlight([%t]) %boldMagenta([%C]) %green([%L]) %m%npattern>
encoder>
appender>
<appender name="INFO_LOG" class="ch.qos.logback.core.rolling.RollingFileAppender">
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>ERRORlevel>
<onMatch>DENYonMatch>
<onMismatch>ACCEPTonMismatch>
filter>
<encoder>
<pattern>[%d{yyyy-MM-dd' 'HH:mm:ss.SSS}] [%C] [%t] [%L] [%-5p] %m%npattern>
encoder>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${LOG_INFO_HOME}//%d.logfileNamePattern>
<maxHistory>30maxHistory>
rollingPolicy>
appender>
<appender name="ERROR_LOG" class="ch.qos.logback.core.rolling.RollingFileAppender">
<filter class="ch.qos.logback.classic.filter.ThresholdFilter">
<level>ERRORlevel>
filter>
<encoder>
<pattern>[%d{yyyy-MM-dd' 'HH:mm:ss.SSS}] [%C] [%t] [%L] [%-5p] %m%npattern>
encoder>
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<fileNamePattern>${LOG_ERROR_HOME}//%d.logfileNamePattern>
<maxHistory>30maxHistory>
rollingPolicy>
appender>
<logger name="com.rudecrab.ssm.mapper" level="DEBUG"/>
<root level="info">
<appender-ref ref="CONSOLE_LOG"/>
<appender-ref ref="INFO_LOG"/>
<appender-ref ref="ERROR_LOG"/>
root>
configuration>
现在我们开始终于可以进行Spring和Mybatis的整合了。我们先在resources文件夹下新建mybatis-config.xml
文件来对Mybatis进行全局配置,这里我习惯配置这些,根据自己的需求来就好:
<configuration>
<settings>
<setting name="logImpl" value="SLF4J"/>
<setting name="useGeneratedKeys" value="true"/>
<setting name="mapUnderscoreToCamelCase" value="true"/>
<setting name="cacheEnabled" value="true"/>
settings>
configuration>
再来新建spring-mybatis.xml
文件,这个文件就是用来做整合的!注意啊,其中很多设置需要指定某个包,这个根据自己项目结构包名来设置,注释写的很清楚了:
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:context="http://www.springframework.org/schema/context"
xmlns:tx="http://www.springframework.org/schema/tx"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/context
https://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx.xsd">
<context:property-placeholder location="classpath:database.properties" file-encoding="UTF-8"/>
<context:component-scan base-package="com.rudecrab.ssm" use-default-filters="true">
<context:exclude-filter type="annotation" expression="org.springframework.stereotype.Controller"/>
context:component-scan>
<bean id="dataSource" class="com.alibaba.druid.pool.DruidDataSource">
<property name="driverClassName" value="${jdbc.driver}"/>
<property name="url" value="${jdbc.url}"/>
<property name="username" value="${jdbc.username}"/>
<property name="password" value="${jdbc.password}"/>
<property name="initialSize" value="10"/>
<property name="maxActive" value="100"/>
bean>
<bean class="org.mybatis.spring.SqlSessionFactoryBean" id="sqlSessionFactory">
<property name="dataSource" ref="dataSource"/>
<property name="configLocation" value="classpath:mybatis-config.xml"/>
<property name="mapperLocations" value="classpath:mapper/*.xml"/>
bean>
<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
<property name="sqlSessionFactoryBeanName" value="sqlSessionFactory"/>
<property name="basePackage" value="com.rudecrab.ssm.mapper"/>
bean>
<bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager">
<property name="dataSource" ref="dataSource"/>
bean>
<tx:annotation-driven/>
beans>
至此Spring和Myabtis已经整合配置好了,口说无凭,咱们还是得测试一下看下效果。在测试之前我们得先建立好mapper接口文件、myabtis映射xml文件、service接口和实现类:
UserMapper接口专门用来声明各种数据库操作方法,@Repository
注解将其定义为Spring所管理的Bean:
@Repository
public interface UserMapper {
/**
* 从数据库中查询出所有的User对象
* @return User对象集合
*/
List<User> selectAll();
}
UserMapper.xml映射文件用来写方法对应要执行的SQL语句:
<mapper namespace="com.rudecrab.ssm.mapper.UserMapper">
<cache/>
<select id="selectAll" resultType="com.rudecrab.ssm.entity.User">
select * from user
select>
mapper>
UserService接口用来声明关于User的业务方法:
public interface UserService {
/**
* 从数据库中查询出所有的User对象
* @return User对象集合
*/
List<User> getAll();
}
UserServiceImpl实体类用来实现关于User的业务逻辑,@Service
注解和@Repository
注解用处一样,将其定义为Bean。@Transactional
注解为声明式事务,如果该业务层的方法有异常抛出则会触发事务回滚。然后使用@Autowired
注解在私有属性上,自动加载Bean,无需我们手动创建UserMapper了:
@Service
@Transactional(rollbackFor = Exception.class)
public class UserServiceImpl implements UserService {
@Autowired
private UserMapper userMapper;
@Override
public List<User> getAll() {
return userMapper.selectAll();
}
}
相关类和文件都建好了,现在我们在test文件夹下建立一个测试类UserServiceTest,一定要在测试类上加上那两个注解,否则无法正常使用Spring相关功能:
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration(locations = {"classpath:spring-mybatis.xml"})
public class UserServiceTest {
@Autowired
private UserService userService;
@Test
public void getAll() {
System.out.println(userService.getAll());
System.out.println(userService.getAll());
}
}
运行后我们就可以看到运行结果了:
可以看到结果正常显示,并且日志也打印在了控制台上。这代表我们已经完成了Spring和Mybatis的整合!
我们接下来配置SpringMVC,在resources目录下新建spring-mvc.xml
文件进行配置。注意啊,其中设置需要指定某个包,这个根据自己项目结构包名来设置:
<beans xmlns="http://www.springframework.org/schema/beans"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:context="http://www.springframework.org/schema/context"
xmlns:mvc="http://www.springframework.org/schema/mvc"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://www.springframework.org/schema/context
https://www.springframework.org/schema/context/spring-context.xsd
http://www.springframework.org/schema/mvc
https://www.springframework.org/schema/mvc/spring-mvc.xsd">
<bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
<property name="prefix" value="/WEB-INF/views/"/>
<property name="suffix" value=".jsp"/>
bean>
<mvc:default-servlet-handler/>
<context:component-scan base-package="com.rudecrab.ssm.controller" use-default-filters="false">
<context:include-filter type="annotation" expression="org.springframework.stereotype.Controller"/>
context:component-scan>
<mvc:annotation-driven/>
beans>
最后一个配置自然就是在web.xml里进行整合了,主要配置三点:
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
version="3.1">
<context-param>
<param-name>contextConfigLocationparam-name>
<param-value>classpath:spring-mybatis.xmlparam-value>
context-param>
<listener>
<listener-class>org.springframework.web.context.ContextLoaderListenerlistener-class>
listener>
<servlet>
<servlet-name>SpringMVCservlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServletservlet-class>
<init-param>
<param-name>contextConfigLocationparam-name>
<param-value>classpath:spring-mvc.xmlparam-value>
init-param>
<load-on-startup>1load-on-startup>
servlet>
<servlet-mapping>
<servlet-name>SpringMVCservlet-name>
<url-pattern>/url-pattern>
servlet-mapping>
<filter>
<filter-name>encodingFilterfilter-name>
<filter-class>org.springframework.web.filter.CharacterEncodingFilterfilter-class>
<init-param>
<param-name>encodingparam-name>
<param-value>UTF-8param-value>
init-param>
<init-param>
<param-name>forceEncodingparam-name>
<param-value>trueparam-value>
init-param>
filter>
<filter-mapping>
<filter-name>encodingFilterfilter-name>
<url-pattern>/*url-pattern>
filter-mapping>
web-app>
以上,所有的配置都弄好了,那么接下来咱们就跑一个最简单的web项目来看看是否整合成功!还记得我们在在spring-mvc.xml
文件中配置的视图解析前缀嘛,我们在**/WEB-INF/views/**文件夹下新建一个index.jsp文件:
<%@ taglib prefix="c" uri="http://java.sun.com/jsp/jstl/core" %>
<%@ page contentType="text/html;charset=UTF-8" language="java" %>
首页-RudeCrab
<%--循环提取userList中的元素--%>
- ${user}
接下来再在controller包下新建一个控制器类来定义访问接口:
@Controller
@RequestMapping(value = "user")
public class UserController {
@Autowired
private UserService userService;
@GetMapping("/getList")
public String getList(Model model) {
// 将数据存到model对象里,这样jsp就能访问数据
model.addAttribute("userList", userService.getAll());
// 返回jsp文件名
return "index";
}
@GetMapping("/getJson")
@ResponseBody
public List<User> getList() {
// 如果想做前后端分离的话可以加上@ResponseBody注解,直接返回数据对象,这样前端就可以通过获取json来渲染数据了
return userService.getAll();
}
}
然后我们启动Tomcat,在浏览器中访问接口:
可以看到我们成功的访问到了数据,至此SSM完全整合完毕!
整体的整合配置思路已经画好思维导图了,其中每个节点上都写好了比较详细的备注,可以下载文件后观看。文件放在末位的github地址中:
https://github.com/RudeCrab/rude-java/tree/master/project-practice/ssm
上面包含了整个项目,clone下来用idea打开即可运行!同时也放上了思维导图文件。如果对你有帮助麻烦点一个star,项目中还有其他的【项目实践】,将来我也会不断更新更多的项目实践!