前言
如果看过前几篇文章,对
Spring
和MyBatis
有了一定了解,一定想上手试试。这篇文章从 0 到 1,手把手整合SSM
(Spring、Spring MVC、MyBatis)。本篇是代码篇,在 PC 端浏览更佳,源码在文末
搭建整合 SSM 之 HelloWorld
开发环境
- idea
- MySql5.x
- jdk8
- maven
对应的技术入门在 公众号 历史文章 都可以找到
目录
目录包括 main、resources、mapper、webapp,不一一介绍,不熟悉查看前面文章。
环境搭建
新建项目
这里使用的是 IDEA 编辑器,新建一个 Maven 工程,选择 web 项目。
导入依赖
使用 Maven 管理项目 jar ,只需要在 pom.xml
加如相关依赖即可。
<?xml version="1.0" encoding="UTF-8"?> <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd"> <modelVersion>4.0.0</modelVersion> <groupId>javapub.rodert.github</groupId> <artifactId>ssm_helloword_web</artifactId> <version>1.0-SNAPSHOT</version> <packaging>war</packaging> <url></url> <!-- 源码:https://github.com/Rodert/JavaPub--> <properties> <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding> <spring.version>4.3.6.RELEASE</spring.version> </properties> <dependencies> <!-- 单元测试 --> <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <version>4.12</version> </dependency> <!-- 1.日志 --> <!-- 实现slf4j接口并整合 --> <dependency> <groupId>ch.qos.logback</groupId> <artifactId>logback-classic</artifactId> <version>1.1.1</version> </dependency> <!-- 2.数据库 --> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>5.1.37</version> <scope>runtime</scope> </dependency> <dependency> <groupId>c3p0</groupId> <artifactId>c3p0</artifactId> <version>0.9.1.2</version> </dependency> <!-- DAO: MyBatis --> <dependency> <groupId>org.mybatis</groupId> <artifactId>mybatis</artifactId> <version>3.3.0</version> </dependency> <dependency> <groupId>org.mybatis</groupId> <artifactId>mybatis-spring</artifactId> <version>1.2.3</version> </dependency> <!-- 3.Servlet web --> <dependency> <groupId>taglibs</groupId> <artifactId>standard</artifactId> <version>1.1.2</version> </dependency> <dependency> <groupId>jstl</groupId> <artifactId>jstl</artifactId> <version>1.2</version> </dependency> <dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-databind</artifactId> <version>2.5.4</version> </dependency> <dependency> <groupId>javax.servlet</groupId> <artifactId>javax.servlet-api</artifactId> <version>3.1.0</version> </dependency> <!-- 4.Spring --> <!-- 1)Spring核心 --> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-core</artifactId> <version>${spring.version}</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-beans</artifactId> <version>${spring.version}</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-context</artifactId> <version>${spring.version}</version> </dependency> <!-- 2)Spring DAO层 --> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-jdbc</artifactId> <version>${spring.version}</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-tx</artifactId> <version>${spring.version}</version> </dependency> <!-- 3)Spring web --> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-web</artifactId> <version>${spring.version}</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-webmvc</artifactId> <version>${spring.version}</version> </dependency> <!-- 4)Spring test --> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-test</artifactId> <version>${spring.version}</version> </dependency> <!-- redis客户端:Jedis --> <dependency> <groupId>redis.clients</groupId> <artifactId>jedis</artifactId> <version>2.7.3</version> </dependency> <dependency> <groupId>com.dyuproject.protostuff</groupId> <artifactId>protostuff-core</artifactId> <version>1.0.8</version> </dependency> <dependency> <groupId>com.dyuproject.protostuff</groupId> <artifactId>protostuff-runtime</artifactId> <version>1.0.8</version> </dependency> <!-- Map工具类 --> <dependency> <groupId>commons-collections</groupId> <artifactId>commons-collections</artifactId> <version>3.2</version> </dependency> <!--注解--> <!-- https://mvnrepository.com/artifact/org.projectlombok/lombok --> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <version>1.18.12</version> <scope>provided</scope> </dependency> </dependencies> <build> <finalName>ssm_helloword_web</finalName> <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-compiler-plugin</artifactId> <configuration> <source>7</source> <target>7</target> </configuration> </plugin> </plugins> </build> </project> <!-- 源码:https://github.com/Rodert/JavaPub-->
编码
配置文件
spring-dao.xml
- 先在spring文件夹里新建spring-dao.xml文件,我们这里分三层,分别是dao service web。
- 加载数据库配置
- 配置数据库连接池
- 配置
SqlSessionFactory
对象(MyBatis) - 配置扫描 dao 层接口,动态代理实现 Dao 实现类,执行 sql 写在 xml
<?xml version="1.0" encoding="UTF-8"?> <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" xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context.xsd"> <!-- 配置整合mybatis过程 --> <!-- 1.配置数据库相关参数properties的属性:${url} --> <context:property-placeholder location="classpath:jdbc.properties" /> <!-- 2.数据库连接池 --> <bean id="dataSource" class="com.mchange.v2.c3p0.ComboPooledDataSource"> <!-- 配置连接池属性 --> <property name="driverClass" value="${jdbc.driver}" /> <property name="jdbcUrl" value="${jdbc.url}" /> <property name="user" value="${jdbc.username}" /> <property name="password" value="${jdbc.password}" /> <!-- c3p0连接池的私有属性 --> <property name="maxPoolSize" value="30" /> <property name="minPoolSize" value="10" /> <!-- 关闭连接后不自动commit --> <property name="autoCommitOnClose" value="false" /> <!-- 获取连接超时时间 --> <property name="checkoutTimeout" value="10000" /> <!-- 当获取连接失败重试次数 --> <property name="acquireRetryAttempts" value="2" /> </bean> <!-- 3.配置SqlSessionFactory对象 --> <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean"> <!-- 注入数据库连接池 --> <property name="dataSource" ref="dataSource" /> <!-- 配置MyBaties全局配置文件:mybatis-config.xml --> <property name="configLocation" value="classpath:Mybatis-config.xml" /> <!-- 扫描entity包 使用别名 --> <property name="typeAliasesPackage" value="javapub.rodert.github.entity" /> <!-- 扫描sql配置文件:mapper需要的xml文件 --> <property name="mapperLocations" value="classpath:mapper/*.xml" /> </bean> <!-- 4.配置扫描Dao接口包,动态实现Dao接口,注入到spring容器中 --> <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer"> <!-- 注入sqlSessionFactory --> <property name="sqlSessionFactoryBeanName" value="sqlSessionFactory" /> <!-- 给出需要扫描Dao接口包 --> <property name="basePackage" value="javapub.rodert.github.dao" /> </bean> </beans>
jdbc.properties
数据库配置,在 resources
文件夹里新建一个 jdbc.properties
文件,注意自己的密码。
jdbc.driver=com.mysql.jdbc.Driver jdbc.url=jdbc:mysql://localhost:3306/ssm1?useUnicode=true&characterEncoding=utf8 jdbc.username=root jdbc.password=
mybatis-config.xml
MyBatis
核心文件,在recources文件夹里新建mybatis-config.xml文件。
- 使用自增主键
- 使用列别名
- 开启驼峰命名转换 create_time -> createTime
<?xml version="1.0" encoding="UTF-8" ?> <!DOCTYPE configuration PUBLIC "-//mybatis.org//DTD Config 3.0//EN" "http://mybatis.org/dtd/mybatis-3-config.dtd"> <configuration> <!-- 配置全局属性 --> <settings> <!-- 使用jdbc的getGeneratedKeys获取数据库自增主键值 --> <setting name="useGeneratedKeys" value="true" /> <!-- 使用列别名替换列名 默认:true --> <setting name="useColumnLabel" value="true" /> <!-- 开启驼峰命名转换:Table{create_time} -> Entity{createTime} --> <setting name="mapUnderscoreToCamelCase" value="true" /> </settings> </configuration>
spring-service.xml
在 spring 文件夹里新建 spring-service.xml
文件。
- 扫描 service 包所有注解 @Service
- 配置事务管理器,把事务管理交由 spring 来完成
- 基于注解的 声明式事务,可以直接在方法上
@Transaction
<?xml version="1.0" encoding="UTF-8"?> <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 http://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx.xsd"> <!-- 扫描service包下所有使用注解的类型 --> <context:component-scan base-package="javapub.rodert.github.service" /> <!-- 配置事务管理器 --> <bean id="transactionManager" class="org.springframework.jdbc.datasource.DataSourceTransactionManager"> <!-- 注入数据库连接池 --> <property name="dataSource" ref="dataSource" /> </bean> <!-- 配置基于注解的声明式事务 --> <tx:annotation-driven transaction-manager="transactionManager" /> </beans>
spring-web.xml
web 层,在 spring 文件夹里新建 spring-web.xml
文件。
- 开启SpringMVC注解模式,可以使用@RequestMapping,@PathVariable,@ResponseBody等
- 对静态资源处理,如js,css,jpg等
- 配置jsp 显示ViewResolver,及渲染后的 JSP
- 扫描web层 @Controller
<?xml version="1.0" encoding="UTF-8"?> <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 http://www.springframework.org/schema/context/spring-context.xsd http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-3.0.xsd"> <!-- 配置SpringMVC --> <!-- 1.开启SpringMVC注解模式 --> <!-- 简化配置: (1)自动注册DefaultAnootationHandlerMapping,AnotationMethodHandlerAdapter (2)提供一些列:数据绑定,数字和日期的format @NumberFormat, @DateTimeFormat, xml,json默认读写支持 --> <mvc:annotation-driven /> <!-- 2.静态资源默认servlet配置 (1)加入对静态资源的处理:js,gif,png (2)允许使用"/"做整体映射 --> <mvc:default-servlet-handler/> <!-- 3.配置jsp 显示ViewResolver --> <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver"> <property name="viewClass" value="org.springframework.web.servlet.view.JstlView" /> <!-- <property name="contentType" value="text/html"/>--> <property name="prefix" value="/WEB-INF/jsp/" /> <property name="suffix" value=".jsp" /> </bean> <!-- 4.扫描web相关的bean --> <context:component-scan base-package="javapub.rodert.github.web" /> </beans>
web.xml
修改 web.xml
文件了,它在 webapp 的 WEB-INF 下。也可以在这里配置过滤器、监听器等。
<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" metadata-complete="true"> <!-- 如果是用mvn命令生成的xml,需要修改servlet版本为3.1 --> <!-- 配置DispatcherServlet --> <servlet> <servlet-name>dispatcherServlet</servlet-name> <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class> <!-- 配置springMVC需要加载的配置文件 spring-dao.xml,spring-service.xml,spring-web.xml Mybatis - > spring -> springmvc --> <init-param> <param-name>contextConfigLocation</param-name> <param-value>classpath:spring/spring-*.xml</param-value> </init-param> <load-on-startup>1</load-on-startup> </servlet> <servlet-mapping> <servlet-name>dispatcherServlet</servlet-name> <!-- 默认匹配所有的请求 --> <url-pattern>/</url-pattern> </servlet-mapping> <welcome-file-list> <welcome-file>index.jsp</welcome-file> </welcome-file-list> </web-app>
日志
配置一些简单的日志,使用 logback
,在 resources
文件夹里新建logback.xml
文件。
<?xml version="1.0" encoding="UTF-8"?> <configuration debug="true"> <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> <!-- encoders are by default assigned the type ch.qos.logback.classic.encoder.PatternLayoutEncoder --> <encoder> <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern> </encoder> </appender> <root level="debug"> <appender-ref ref="STDOUT" /> </root> </configuration>
配置说明
以上配置是整合 SSM
的基础配置,目录结构如图所示:
SSM实例-图书管理系统
sql
以上部分整个 SSM 框架就已经搭建好了,下面是一个 Demo ,供参考。
新建俩张表,图书表 book
和 预约图书表 appointment
,并初始化数据。
/* Navicat MySQL Data Transfer Source Server : localhost Source Server Version : 50716 Source Host : localhost:3306 Source Database : ssm1 Target Server Type : MYSQL Target Server Version : 50716 File Encoding : 65001 Date: 2020-07-12 16:50:43 */ SET FOREIGN_KEY_CHECKS=0; -- ---------------------------- -- Table structure for appointment -- ---------------------------- DROP TABLE IF EXISTS `appointment`; CREATE TABLE `appointment` ( `book_id` bigint(20) NOT NULL COMMENT '图书ID', `student_id` bigint(20) NOT NULL COMMENT '学号', `appoint_time` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '预约时间', PRIMARY KEY (`book_id`,`student_id`), KEY `idx_appoint_time` (`appoint_time`) ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='预约图书表'; -- ---------------------------- -- Records of appointment -- ---------------------------- -- ---------------------------- -- Table structure for book -- ---------------------------- DROP TABLE IF EXISTS `book`; CREATE TABLE `book` ( `book_id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT '图书ID', `name` varchar(100) NOT NULL COMMENT '图书名称', `number` int(11) NOT NULL COMMENT '馆藏数量', PRIMARY KEY (`book_id`) ) ENGINE=InnoDB AUTO_INCREMENT=1004 DEFAULT CHARSET=utf8 COMMENT='图书表'; -- ---------------------------- -- Records of book -- ---------------------------- INSERT INTO `book` VALUES ('2000', 'Java程序设计', '20'); INSERT INTO `book` VALUES ('2001', '数据结构', '7'); INSERT INTO `book` VALUES ('2002', '设计模式', '20'); INSERT INTO `book` VALUES ('2003', '编译原理', '20');
实体
在 entity
包下新建实体 Book
和 Appointment
- Book.java
package javapub.rodert.github.entity; import lombok.Getter; import lombok.Setter; import lombok.ToString; /** * @author wangshiyu rodert * @date 2020/7/6 20:58 * @description * * @Data 注解,简化代码,自动添加get set toSting 方法 * @Getter * @Setter * @ToString */ @Getter @Setter @ToString public class Book { private long bookId;// 图书ID private String name;// 图书名称 private int number;// 馆藏数量 // 省略构造方法,getter和setter方法,toString方法 }
- Appointment.java
package javapub.rodert.github.entity; /** * @author wangshiyu rodert * @date 2020/7/6 20:58 * @description */ import lombok.Data; import lombok.Getter; import lombok.Setter; import lombok.ToString; import java.util.Date; /** * 预约图书实体 * @Data 注解,简化代码,自动添加get set toSting 方法 */ @Data public class Appointment { private long bookId;// 图书ID private long studentId;// 学号 private Date appointTime;// 预约时间 // 多对一的复合属性 private Book book;// 图书实体 // 省略构造方法,getter和setter方法,toString方法 }
dao接口
在dao
包新建接口 BookDao.java
和 Appointment.java
- BookDao.java
package javapub.rodert.github.dao; /** * @author wangshiyu rodert * @date 2020/7/6 21:01 * @description */ import javapub.rodert.github.entity.Book; import org.apache.ibatis.annotations.Param; import java.util.List; public interface BookDao { /** * 通过ID查询单本图书 * * @param id * @return */ Book queryById(long id); /** * 查询所有图书 * * @param offset 查询起始位置 * @param limit 查询条数 * @return */ List<Book> queryAll(@Param("offset") int offset, @Param("limit") int limit); /** * 减少馆藏数量 * * @param bookId * @return 如果影响行数等于>1,表示更新的记录行数 */ int reduceNumber(long bookId); }
- AppointmentDao.java
package javapub.rodert.github.dao; /** * @author wangshiyu rodert * @date 2020/7/6 21:01 * @description */ import javapub.rodert.github.entity.Appointment; import org.apache.ibatis.annotations.Param; public interface AppointmentDao { /** * 插入预约图书记录 * * @param bookId * @param studentId * @return 插入的行数 */ int insertAppointment(@Param("bookId") long bookId, @Param("studentId") long studentId); /** * 通过主键查询预约图书记录,并且携带图书实体 * * @param bookId * @param studentId * @return */ Appointment queryByKeyWithBook(@Param("bookId") long bookId, @Param("studentId") long studentId); }
提示:这里为什么要给方法的参数添加 @Param注解呢?是因为该方法有两个或以上的参数,一定要加,不然 mybatis 识别不了。上面的 BookDao 接口的 queryById 方法和 reduceNumber 方法只有一个参数 book_id ,所以可以不用加 @Param 注解。
手把手整合SSM框架2:https://developer.aliyun.com/article/1536319?spm=a2c6h.24874632.expert-profile.16.f381397fkr25Rk