我们看招聘信息的时候,经常会看到这一点,需要具备SSH框架的技能;而且在大部分教学课堂中,也会把SSH作为最核心的教学内容。
但是,我们在实际应用中发现,SpringMVC可以完全替代Struts,配合注解的方式,编程非常快捷,而且通过restful风格定义url,让地址看起来非常优雅。
另外,MyBatis也可以替换Hibernate,正因为MyBatis的半自动特点,我们程序猿可以完全掌控SQL,这会让有数据库经验的程序猿能开发出高效率的SQL语句,而且XML配置管理起来也非常方便。
好了,如果你也认同我的看法,那么下面我们一起来做整合吧!
引言
在写代码之前我们先了解一下这三个框架分别是干什么的?
相信大以前也看过不少这些概念,我这就用大白话来讲,如果之前有了解过可以跳过这一大段,直接看代码!
-
SpringMVC:它用于web层,相当于controller(等价于传统的servlet和struts的action),用来处理用户请求。举个例子,用户在地址栏输入http://网站域名/login,那么springmvc就会拦截到这个请求,并且调用controller层中相应的方法,(中间可能包含验证用户名和密码的业务逻辑,以及查询数据库操作,但这些都不是springmvc的职责),最终把结果返回给用户,并且返回相应的页面(当然也可以只返回json/xml等格式数据)。springmvc就是做前面和后面过程的活,与用户打交道!!
-
Spring:太强大了,以至于我无法用一个词或一句话来概括它。但与我们平时开发接触最多的估计就是IOC容器,它可以装载bean(也就是我们java中的类,当然也包括service dao里面的),有了这个机制,我们就不用在每次使用这个类的时候为它初始化,很少看到关键字new。另外spring的aop,事务管理等等都是我们经常用到的。
-
MyBatis:如果你问我它跟鼎鼎大名的Hibernate有什么区别?我只想说,他更符合我的需求。第一,它能自由控制sql,这会让有数据库经验的人(当然不是说我啦~捂脸~)编写的代码能搞提升数据库访问的效率。第二,它可以使用xml的方式来组织管理我们的sql,因为一般程序出错很多情况下是sql出错,别人接手代码后能快速找到出错地方,甚至可以优化原来写的sql。
SSM框架整合配置
好了,前面bb那么多,下面我们真正开始敲代码了~
首先我们打开IED,我这里用的是eclipse(你们应该也是用的这个,对吗?),创建一个动态web项目,建立好相应的目录结构(重点!)
(打了马赛克是因为这里还用不到,你们不要那么污好不好?)
我说一下每个目录都有什么用吧(第一次画表格,我发现markdown的表格语法很不友好呀~)
这个目录结构同时也遵循maven的目录规范~
文件名 | 作用 |
---|---|
src | 根目录,没什么好说的,下面有main和test。 |
|
主要目录,可以放java代码和一些资源文件。 |
|
存放我们的java代码,这个文件夹要使用Build Path -> Use as Source Folder,这样看包结构会方便很多,新建的包就相当于在这里新建文件夹咯。 |
|
存放资源文件,譬如各种的spring,mybatis,log配置文件。 |
|
存放dao中每个方法对应的sql,在这里配置,无需写daoImpl。 |
|
这里当然是存放spring相关的配置文件,有dao service web三层。 |
|
其实这个可以没有,但是为了项目完整性还是加上吧。 |
|
这个貌似是最熟悉的目录了,用来存放我们前端的静态资源,如jsp js css。 |
|
这里的资源是指项目的静态资源,如js css images等。 |
|
很重要的一个目录,外部浏览器无法访问,只有羡慕内部才能访问,可以把jsp放在这里,另外就是web.xml了。你可能有疑问了,为什么上面java中的resources里面的配置文件不妨在这里,那么是不是会被外部窃取到?你想太多了,部署时候基本上只有webapp里的会直接输出到根目录,其他都会放入WEB-INF里面,项目内部依然可以使用classpath:XXX来访问,好像IDE里可以设置部署输出目录,这里扯远了~ |
|
这里是测试分支。 |
|
测试java代码,应遵循包名相同的原则,这个文件夹同样要使用Build Path -> Use as Source Folder,这样看包结构会方便很多。 |
|
没什么好说的,好像也很少用到,但这个是maven的规范。 |
我先新建好几个必要的包,并为大家讲解一下每个包的作用,顺便理清一下后台的思路~
包名 | 名称 | 作用 |
---|---|---|
dao | 数据访问层(接口) | 与数据打交道,可以是数据库操作,也可以是文件读写操作,甚至是redis缓存操作,总之与数据操作有关的都放在这里,也有人叫做dal或者数据持久层都差不多意思。为什么没有daoImpl,因为我们用的是mybatis,所以可以直接在配置文件中实现接口的每个方法。 |
entity | 实体类 | 一般与数据库的表相对应,封装dao层取出来的数据为一个对象,也就是我们常说的pojo,一般只在dao层与service层之间传输。 |
dto | 数据传输层 | 刚学框架的人可能不明白这个有什么用,其实就是用于service层与web层之间传输,为什么不直接用entity(pojo)?其实在实际开发中发现,很多时间一个entity并不能满足我们的业务需求,可能呈现给用户的信息十分之多,这时候就有了dto,也相当于vo,记住一定不要把这个混杂在entity里面,答应我好吗? |
service | 业务逻辑(接口) | 写我们的业务逻辑,也有人叫bll,在设计业务接口时候应该站在“使用者”的角度。额,不要问我为什么这里没显示!IDE调皮我也拿它没办法~ |
serviceImpl | 业务逻辑(实现) | 实现我们业务接口,一般事务控制是写在这里,没什么好说的。 |
web | 控制器 | springmvc就是在这里发挥作用的,一般人叫做controller控制器,相当于struts中的action。 |
还有最后一步基础工作,导入我们相应的jar包,我使用的是maven来管理我们的jar,所以只需要在pom.xml
中加入相应的依赖就好了,如果不使用maven的可以自己去官网下载相应的jar,放到项目WEB-INF/lib目录下。关于maven的学习大家可以看慕课网的视频教程,这里就不展开了。我把项目用到的jar都写在下面,版本都不是最新的,大家有经验的话可以自己调整版本号。
配置pom.xml
1 <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 2 xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/maven-v4_0_0.xsd"> 3 <modelVersion>4.0.0</modelVersion> 4 <groupId>com.soecode.ssm</groupId> 5 <artifactId>ssm</artifactId> 6 <packaging>war</packaging> 7 <version>0.0.1-SNAPSHOT</version> 8 <name>ssm Maven Webapp</name> 9 <url>http://github.com/liyifeng1994/ssm</url> 10 <dependencies> 11 <!-- 单元测试 --> 12 <dependency> 13 <groupId>junit</groupId> 14 <artifactId>junit</artifactId> 15 <version>4.11</version> 16 </dependency> 17 18 <!-- 1.日志 --> 19 <!-- 实现slf4j接口并整合 --> 20 <dependency> 21 <groupId>ch.qos.logback</groupId> 22 <artifactId>logback-classic</artifactId> 23 <version>1.1.1</version> 24 </dependency> 25 26 <!-- 2.数据库 --> 27 <dependency> 28 <groupId>mysql</groupId> 29 <artifactId>mysql-connector-java</artifactId> 30 <version>5.1.37</version> 31 <scope>runtime</scope> 32 </dependency> 33 <dependency> 34 <groupId>c3p0</groupId> 35 <artifactId>c3p0</artifactId> 36 <version>0.9.1.2</version> 37 </dependency> 38 39 <!-- DAO: MyBatis --> 40 <dependency> 41 <groupId>org.mybatis</groupId> 42 <artifactId>mybatis</artifactId> 43 <version>3.3.0</version> 44 </dependency> 45 <dependency> 46 <groupId>org.mybatis</groupId> 47 <artifactId>mybatis-spring</artifactId> 48 <version>1.2.3</version> 49 </dependency> 50 51 <!-- 3.Servlet web --> 52 <dependency> 53 <groupId>taglibs</groupId> 54 <artifactId>standard</artifactId> 55 <version>1.1.2</version> 56 </dependency> 57 <dependency> 58 <groupId>jstl</groupId> 59 <artifactId>jstl</artifactId> 60 <version>1.2</version> 61 </dependency> 62 <dependency> 63 <groupId>com.fasterxml.jackson.core</groupId> 64 <artifactId>jackson-databind</artifactId> 65 <version>2.5.4</version> 66 </dependency> 67 <dependency> 68 <groupId>javax.servlet</groupId> 69 <artifactId>javax.servlet-api</artifactId> 70 <version>3.1.0</version> 71 </dependency> 72 73 <!-- 4.Spring --> 74 <!-- 1)Spring核心 --> 75 <dependency> 76 <groupId>org.springframework</groupId> 77 <artifactId>spring-core</artifactId> 78 <version>4.1.7.RELEASE</version> 79 </dependency> 80 <dependency> 81 <groupId>org.springframework</groupId> 82 <artifactId>spring-beans</artifactId> 83 <version>4.1.7.RELEASE</version> 84 </dependency> 85 <dependency> 86 <groupId>org.springframework</groupId> 87 <artifactId>spring-context</artifactId> 88 <version>4.1.7.RELEASE</version> 89 </dependency> 90 <!-- 2)Spring DAO层 --> 91 <dependency> 92 <groupId>org.springframework</groupId> 93 <artifactId>spring-jdbc</artifactId> 94 <version>4.1.7.RELEASE</version> 95 </dependency> 96 <dependency> 97 <groupId>org.springframework</groupId> 98 <artifactId>spring-tx</artifactId> 99 <version>4.1.7.RELEASE</version> 100 </dependency> 101 <!-- 3)Spring web --> 102 <dependency> 103 <groupId>org.springframework</groupId> 104 <artifactId>spring-web</artifactId> 105 <version>4.1.7.RELEASE</version> 106 </dependency> 107 <dependency> 108 <groupId>org.springframework</groupId> 109 <artifactId>spring-webmvc</artifactId> 110 <version>4.1.7.RELEASE</version> 111 </dependency> 112 <!-- 4)Spring test --> 113 <dependency> 114 <groupId>org.springframework</groupId> 115 <artifactId>spring-test</artifactId> 116 <version>4.1.7.RELEASE</version> 117 </dependency> 118 119 <!-- redis客户端:Jedis --> 120 <dependency> 121 <groupId>redis.clients</groupId> 122 <artifactId>jedis</artifactId> 123 <version>2.7.3</version> 124 </dependency> 125 <dependency> 126 <groupId>com.dyuproject.protostuff</groupId> 127 <artifactId>protostuff-core</artifactId> 128 <version>1.0.8</version> 129 </dependency> 130 <dependency> 131 <groupId>com.dyuproject.protostuff</groupId> 132 <artifactId>protostuff-runtime</artifactId> 133 <version>1.0.8</version> 134 </dependency> 135 136 <!-- Map工具类 --> 137 <dependency> 138 <groupId>commons-collections</groupId> 139 <artifactId>commons-collections</artifactId> 140 <version>3.2</version> 141 </dependency> 142 </dependencies> 143 <build> 144 <finalName>ssm</finalName> 145 </build> 146 </project>
下面真的要开始进行编码工作了,坚持到这里辛苦大家了~
第一步:我们先在spring
文件夹里新建spring-dao.xml
文件,因为spring的配置太多,我们这里分三层,分别是dao service web。
- 读入数据库连接相关参数(可选)
- 配置数据连接池
- 配置连接属性,可以不读配置项文件直接在这里写死
- 配置c3p0,只配了几个常用的
- 配置SqlSessionFactory对象(mybatis)
- 扫描dao层接口,动态实现dao接口,也就是说不需要daoImpl,sql和参数都写在xml文件上
配置spring-dao.xml
1 <?xml version="1.0" encoding="UTF-8"?> 2 <beans xmlns="http://www.springframework.org/schema/beans" 3 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:context="http://www.springframework.org/schema/context" 4 xsi:schemaLocation="http://www.springframework.org/schema/beans 5 http://www.springframework.org/schema/beans/spring-beans.xsd 6 http://www.springframework.org/schema/context 7 http://www.springframework.org/schema/context/spring-context.xsd"> 8 <!-- 配置整合mybatis过程 --> 9 <!-- 1.配置数据库相关参数properties的属性:${url} --> 10 <context:property-placeholder location="classpath:jdbc.properties" /> 11 12 <!-- 2.数据库连接池 --> 13 <bean id="dataSource" class="com.mchange.v2.c3p0.ComboPooledDataSource"> 14 <!-- 配置连接池属性 --> 15 <property name="driverClass" value="${jdbc.driver}" /> 16 <property name="jdbcUrl" value="${jdbc.url}" /> 17 <property name="user" value="${jdbc.username}" /> 18 <property name="password" value="${jdbc.password}" /> 19 20 <!-- c3p0连接池的私有属性 --> 21 <property name="maxPoolSize" value="30" /> 22 <property name="minPoolSize" value="10" /> 23 <!-- 关闭连接后不自动commit --> 24 <property name="autoCommitOnClose" value="false" /> 25 <!-- 获取连接超时时间 --> 26 <property name="checkoutTimeout" value="10000" /> 27 <!-- 当获取连接失败重试次数 --> 28 <property name="acquireRetryAttempts" value="2" /> 29 </bean> 30 31 <!-- 3.配置SqlSessionFactory对象 --> 32 <bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean"> 33 <!-- 注入数据库连接池 --> 34 <property name="dataSource" ref="dataSource" /> 35 <!-- 配置MyBaties全局配置文件:mybatis-config.xml --> 36 <property name="configLocation" value="classpath:mybatis-config.xml" /> 37 <!-- 扫描entity包 使用别名 --> 38 <property name="typeAliasesPackage" value="com.soecode.lyf.entity" /> 39 <!-- 扫描sql配置文件:mapper需要的xml文件 --> 40 <property name="mapperLocations" value="classpath:mapper/*.xml" /> 41 </bean> 42 43 <!-- 4.配置扫描Dao接口包,动态实现Dao接口,注入到spring容器中 --> 44 <bean class="org.mybatis.spring.mapper.MapperScannerConfigurer"> 45 <!-- 注入sqlSessionFactory --> 46 <property name="sqlSessionFactoryBeanName" value="sqlSessionFactory" /> 47 <!-- 给出需要扫描Dao接口包 --> 48 <property name="basePackage" value="com.soecode.lyf.dao" /> 49 </bean> 50 </beans>
因为数据库配置相关参数是读取配置文件,所以在resources
文件夹里新建一个jdbc.properties
文件,存放我们4个最常见的数据库连接属性,这是我本地的,大家记得修改呀~还有喜欢传到github上“大头虾们”记得删掉密码,不然别人就很容易得到你服务器的数据库配置信息,然后干一些羞羞的事情,你懂的!!
配置jdbc.properties
1 jdbc.driver=com.mysql.jdbc.Driver 2 jdbc.url=jdbc:mysql://localhost:3307/ssm?useUnicode=true&characterEncoding=utf8 3 jdbc.username=root 4 jdbc.password=
友情提示:配置文件中的jdbc.username,如果写成username,可能会与系统环境中的username变量冲突,所以到时候真正连接数据库的时候,用户名就被替换成系统中的用户名(有得可能是administrator),那肯定是连接不成功的,这里有个小坑,我被坑了一晚上!!
因为这里用到了mybatis,所以需要配置mybatis核心文件,在recources
文件夹里新建mybatis-config.xml
文件。
- 使用自增主键
- 使用列别名
- 开启驼峰命名转换 create_time -> createTime
配置mybatis-config.xml
1 <?xml version="1.0" encoding="UTF-8" ?> 2 <!DOCTYPE configuration 3 PUBLIC "-//mybatis.org//DTD Config 3.0//EN" 4 "http://mybatis.org/dtd/mybatis-3-config.dtd"> 5 <configuration> 6 <!-- 配置全局属性 --> 7 <settings> 8 <!-- 使用jdbc的getGeneratedKeys获取数据库自增主键值 --> 9 <setting name="useGeneratedKeys" value="true" /> 10 11 <!-- 使用列别名替换列名 默认:true --> 12 <setting name="useColumnLabel" value="true" /> 13 14 <!-- 开启驼峰命名转换:Table{create_time} -> Entity{createTime} --> 15 <setting name="mapUnderscoreToCamelCase" value="true" /> 16 </settings> 17 </configuration>
第二步:刚弄好dao层,接下来到service层了。在spring
文件夹里新建spring-service.xml
文件。
- 扫描service包所有注解 @Service
- 配置事务管理器,把事务管理交由spring来完成
- 配置基于注解的声明式事务,可以直接在方法上@Transaction
配置spring-service.xml
1 <?xml version="1.0" encoding="UTF-8"?> 2 <beans xmlns="http://www.springframework.org/schema/beans" 3 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 4 xmlns:context="http://www.springframework.org/schema/context" 5 xmlns:tx="http://www.springframework.org/schema/tx" 6 xsi:schemaLocation="http://www.springframework.org/schema/beans 7 http://www.springframework.org/schema/beans/spring-beans.xsd 8 http://www.springframework.org/schema/context 9 http://www.springframework.org/schema/context/spring-context.xsd 10 http://www.springframework.org/schema/tx 11 http://www.springframework.org/schema/tx/spring-tx.xsd"> 12 <!-- 扫描service包下所有使用注解的类型 --> 13 <context:component-scan base-package="com.soecode.lyf.service" /> 14 15 <!-- 配置事务管理器 --> 16 <bean id="transactionManager" 17 class="org.springframework.jdbc.datasource.DataSourceTransactionManager"> 18 <!-- 注入数据库连接池 --> 19 <property name="dataSource" ref="dataSource" /> 20 </bean> 21 22 <!-- 配置基于注解的声明式事务 --> 23 <tx:annotation-driven transaction-manager="transactionManager" /> 24 </beans>
第三步:配置web层,在spring
文件夹里新建spring-web.xml
文件。
- 开启SpringMVC注解模式,可以使用@RequestMapping,@PathVariable,@ResponseBody等
- 对静态资源处理,如js,css,jpg等
- 配置jsp 显示ViewResolver,例如在controller中某个方法返回一个string类型的”login”,实际上会返回”/WEB-INF/login.jsp”
- 扫描web层 @Controller
配置spring-web.xml
1 <?xml version="1.0" encoding="UTF-8"?> 2 <beans xmlns="http://www.springframework.org/schema/beans" 3 xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 4 xmlns:context="http://www.springframework.org/schema/context" 5 xmlns:mvc="http://www.springframework.org/schema/mvc" 6 xsi:schemaLocation="http://www.springframework.org/schema/beans 7 http://www.springframework.org/schema/beans/spring-beans.xsd 8 http://www.springframework.org/schema/context 9 http://www.springframework.org/schema/context/spring-context.xsd 10 http://www.springframework.org/schema/mvc 11 http://www.springframework.org/schema/mvc/spring-mvc-3.0.xsd"> 12 <!-- 配置SpringMVC --> 13 <!-- 1.开启SpringMVC注解模式 --> 14 <!-- 简化配置: 15 (1)自动注册DefaultAnootationHandlerMapping,AnotationMethodHandlerAdapter 16 (2)提供一些列:数据绑定,数字和日期的format @NumberFormat, @DateTimeFormat, xml,json默认读写支持 17 --> 18 <mvc:annotation-driven /> 19 20 <!-- 2.静态资源默认servlet配置 21 (1)加入对静态资源的处理:js,gif,png 22 (2)允许使用"/"做整体映射 23 --> 24 <mvc:default-servlet-handler/> 25 26 <!-- 3.配置jsp 显示ViewResolver --> 27 <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver"> 28 <property name="viewClass" value="org.springframework.web.servlet.view.JstlView" /> 29 <property name="prefix" value="/WEB-INF/jsp/" /> 30 <property name="suffix" value=".jsp" /> 31 </bean> 32 33 <!-- 4.扫描web相关的bean --> 34 <context:component-scan base-package="com.soecode.lyf.web" /> 35 </beans>
第四步:最后就是修改web.xml
文件了,它在webapp
的WEB-INF
下。
配置web.xml
1 <web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" 2 xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee 3 http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd" 4 version="3.1" metadata-complete="true"> 5 <!-- 如果是用mvn命令生成的xml,需要修改servlet版本为3.1 --> 6 <!-- 配置DispatcherServlet --> 7 <servlet> 8 <servlet-name>seckill-dispatcher</servlet-name> 9 <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class> 10 <!-- 配置springMVC需要加载的配置文件 11 spring-dao.xml,spring-service.xml,spring-web.xml 12 Mybatis - > spring -> springmvc 13 --> 14 <init-param> 15 <param-name>contextConfigLocation</param-name> 16 <param-value>classpath:spring/spring-*.xml</param-value> 17 </init-param> 18 </servlet> 19 <servlet-mapping> 20 <servlet-name>seckill-dispatcher</servlet-name> 21 <!-- 默认匹配所有的请求 --> 22 <url-pattern>/</url-pattern> 23 </servlet-mapping> 24 </web-app>
我们在项目中经常会使用到日志,所以这里还有配置日志xml,在resources
文件夹里新建logback.xml
文件,所给出的日志输出格式也是最基本的控制台s呼出,大家有兴趣查看logback官方文档。
配置logback.xml
1 <?xml version="1.0" encoding="UTF-8"?> 2 <configuration debug="true"> 3 <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender"> 4 <!-- encoders are by default assigned the type ch.qos.logback.classic.encoder.PatternLayoutEncoder --> 5 <encoder> 6 <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n</pattern> 7 </encoder> 8 </appender> 9 10 <root level="debug"> 11 <appender-ref ref="STDOUT" /> 12 </root> 13 </configuration>
到目前为止,我们一共写了7个配置文件,我们一起来看下最终的配置文件结构图。
SSM框架应用实例(图书管理系统)
一开始想就这样结束教程,但是发现其实很多人都还不会把这个SSM框架用起来,特别是mybatis部分。那我现在就以最常见的“图书管理系统”中【查询图书】和【预约图书】业务来做一个demo吧!
首先新建数据库名为ssm
,再创建两张表:图书表book
和预约图书表appointment
,并且为book
表初始化一些数据,sql如下。
建表schema.sql
1 -- 创建图书表 2 CREATE TABLE `book` ( 3 `book_id` bigint(20) NOT NULL AUTO_INCREMENT COMMENT '图书ID', 4 `name` varchar(100) NOT NULL COMMENT '图书名称', 5 `number` int(11) NOT NULL COMMENT '馆藏数量', 6 PRIMARY KEY (`book_id`) 7 ) ENGINE=InnoDB AUTO_INCREMENT=1000 DEFAULT CHARSET=utf8 COMMENT='图书表' 8 9 -- 初始化图书数据 10 INSERT INTO `book` (`book_id`, `name`, `number`) 11 VALUES 12 (1000, 'Java程序设计', 10), 13 (1001, '数据结构', 10), 14 (1002, '设计模式', 10), 15 (1003, '编译原理', 10) 16 17 -- 创建预约图书表 18 CREATE TABLE `appointment` ( 19 `book_id` bigint(20) NOT NULL COMMENT '图书ID', 20 `student_id` bigint(20) NOT NULL COMMENT '学号', 21 `appoint_time` timestamp NOT NULL DEFAULT CURRENT_TIMESTAMP ON UPDATE CURRENT_TIMESTAMP COMMENT '预约时间' , 22 PRIMARY KEY (`book_id`, `student_id`), 23 INDEX `idx_appoint_time` (`appoint_time`) 24 ) ENGINE=InnoDB DEFAULT CHARSET=utf8 COMMENT='预约图书表'
在entity
包中添加两个对应的实体,图书实体Book.java
和预约图书实体Appointment.java
。
创建实体类Book.java
1 package com.soecode.lyf.entity; 2 3 public class Book { 4 5 private long bookId;// 图书ID 6 7 private String name;// 图书名称 8 9 private int number;// 馆藏数量 10 11 // 省略构造方法,getter和setter方法,toString方法 12 13 }
创建实体类Appointment.java
1 package com.soecode.lyf.entity; 2 3 import java.util.Date; 4 5 /** 6 * 预约图书实体 7 */ 8 public class Appointment { 9 10 private long bookId;// 图书ID 11 12 private long studentId;// 学号 13 14 private Date appointTime;// 预约时间 15 16 // 多对一的复合属性 17 private Book book;// 图书实体 18 19 // 省略构造方法,getter和setter方法,toString方法 20 21 }
在dao
包新建接口BookDao.java
和Appointment.java
创建接口BookDao.java
1 package com.soecode.lyf.dao; 2 3 import java.util.List; 4 5 import com.soecode.lyf.entity.Book; 6 7 public interface BookDao { 8 9 /** 10 * 通过ID查询单本图书 11 * 12 * @param id 13 * @return 14 */ 15 Book queryById(long id); 16 17 /** 18 * 查询所有图书 19 * 20 * @param offset 查询起始位置 21 * @param limit 查询条数 22 * @return 23 */ 24 List<Book> queryAll(@Param("offset") int offset, @Param("limit") int limit); 25 26 /** 27 * 减少馆藏数量 28 * 29 * @param bookId 30 * @return 如果影响行数等于>1,表示更新的记录行数 31 */ 32 int reduceNumber(long bookId); 33 }
创建接口AppointmentDao.java
1 package com.soecode.lyf.dao; 2 3 import org.apache.ibatis.annotations.Param; 4 5 import com.soecode.lyf.entity.Appointment; 6 7 public interface AppointmentDao { 8 9 /** 10 * 插入预约图书记录 11 * 12 * @param bookId 13 * @param studentId 14 * @return 插入的行数 15 */ 16 int insertAppointment(@Param("bookId") long bookId, @Param("studentId") long studentId); 17 18 /** 19 * 通过主键查询预约图书记录,并且携带图书实体 20 * 21 * @param bookId 22 * @param studentId 23 * @return 24 */ 25 Appointment queryByKeyWithBook(@Param("bookId") long bookId, @Param("studentId") long studentId); 26 27 }
提示:这里为什么要给方法的参数添加@Param
注解呢?是因为该方法有两个或以上的参数,一定要加,不然mybatis识别不了。上面的BookDao
接口的queryById
方法和reduceNumber
方法只有一个参数book_id
,所以可以不用加 @Param
注解,当然加了也无所谓~
注意,这里不需要实现dao接口不用编写daoImpl, mybatis会给我们动态实现,但是我们需要编写相应的mapper。
在mapper
目录里新建两个文件BookDao.xml
和AppointmentDao.xml
,分别对应上面两个dao接口,代码如下。
编写dao接口mapper文件BookDao.xml
1 <?xml version="1.0" encoding="UTF-8"?> 2 <!DOCTYPE mapper 3 PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" 4 "http://mybatis.org/dtd/mybatis-3-mapper.dtd"> 5 <mapper namespace="com.soecode.lyf.dao.BookDao"> 6 <!-- 目的:为dao接口方法提供sql语句配置 --> 7 <select id="queryById" resultType="Book" parameterType="long"> 8 <!-- 具体的sql --> 9 SELECT 10 book_id, 11 name, 12 number 13 FROM 14 book 15 WHERE 16 book_id = #{bookId} 17 </select> 18 19 <select id="queryAll" resultType="Book"> 20 SELECT 21 book_id, 22 name, 23 number 24 FROM 25 book 26 ORDER BY 27 book_id 28 LIMIT #{offset}, #{limit} 29 </select> 30 31 <update id="reduceNumber"> 32 UPDATE book 33 SET number = number - 1 34 WHERE 35 book_id = #{bookId} 36 AND number > 0 37 </update> 38 </mapper>
编写dao接口mapper文件AppointmentDao.xml
1 <?xml version="1.0" encoding="UTF-8"?> 2 <!DOCTYPE mapper 3 PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN" 4 "http://mybatis.org/dtd/mybatis-3-mapper.dtd"> 5 <mapper namespace="com.soecode.lyf.dao.AppointmentDao"> 6 <insert id="insertAppointment"> 7 <!-- ignore 主键冲突,报错 --> 8 INSERT ignore INTO appointment (book_id, student_id) 9 VALUES (#{bookId}, #{studentId}) 10 </insert> 11 12 <select id="queryByKeyWithBook" resultType="Appointment"> 13 <!-- 如何告诉MyBatis把结果映射到Appointment同时映射book属性 --> 14 <!-- 可以自由控制SQL --> 15 SELECT 16 a.book_id, 17 a.student_id, 18 a.appoint_time, 19 b.book_id "book.book_id", 20 b.`name` "book.name", 21 b.number "book.number" 22 FROM 23 appointment a 24 INNER JOIN book b ON a.book_id = b.book_id 25 WHERE 26 a.book_id = #{bookId} 27 AND a.student_id = #{studentId} 28 </select> 29 </mapper>
mapper总结:namespace
是该xml对应的接口全名,select
和update
中的id
对应方法名,resultType
是返回值类型,parameterType
是参数类型(这个其实可选),最后#{...}
中填写的是方法的参数,看懂了是不是很简单!!我也这么觉得~ 还有一个小技巧要交给大家,就是在返回Appointment
对象包含了一个属性名为book
的Book对象,那么可以使用"book.属性名"
的方式来取值,看上面queryByKeyWithBook
方法的sql。
dao
层写完了,接下来test
对应的package
写我们测试方法吧。
因为我们之后会写很多测试方法,在测试前需要让程序读入spring-dao和mybatis等配置文件,所以我这里就抽离出来一个BaseTest
类,只要是测试方法就继承它,这样那些繁琐的重复的代码就不用写那么多了~
测试类BaseTest.java
1 package com.soecode.lyf; 2 3 import org.junit.runner.RunWith; 4 import org.springframework.test.context.ContextConfiguration; 5 import org.springframework.test.context.junit4.SpringJUnit4ClassRunner; 6 7 /** 8 * 配置spring和junit整合,junit启动时加载springIOC容器 spring-test,junit 9 */ 10 @RunWith(SpringJUnit4ClassRunner.class) 11 // 告诉junit spring配置文件 12 @ContextConfiguration({ "classpath:spring/spring-dao.xml", "classpath:spring/spring-service.xml" }) 13 public class BaseTest { 14 15 }
因为spring-service
在service
层的测试中会时候到,这里也一起引入算了!
新建BookDaoTest.java
和AppointmentDaoTest.java
两个dao测试文件。
测试类BookDaoTest.java
1 package com.soecode.lyf.dao; 2 3 import java.util.List; 4 5 import org.junit.Test; 6 import org.springframework.beans.factory.annotation.Autowired; 7 8 import com.soecode.lyf.BaseTest; 9 import com.soecode.lyf.entity.Book; 10 11 public class BookDaoTest extends BaseTest { 12 13 @Autowired 14 private BookDao bookDao; 15 16 @Test 17 public void testQueryById() throws Exception { 18 long bookId = 1000; 19 Book book = bookDao.queryById(bookId); 20 System.out.println(book); 21 } 22 23 @Test 24 public void testQueryAll() throws Exception { 25 List<Book> books = bookDao.queryAll(0, 4); 26 for (Book book : books) { 27 System.out.println(book); 28 } 29 } 30 31 @Test 32 public void testReduceNumber() throws Exception { 33 long bookId = 1000; 34 int update = bookDao.reduceNumber(bookId); 35 System.out.println("update=" + update); 36 } 37 38 }
BookDaoTest测试结果
testQueryById
testQueryAll
testReduceNumber
测试类AppointmentDaoTest.java
1 package com.soecode.lyf.dao; 2 3 import org.junit.Test; 4 import org.springframework.beans.factory.annotation.Autowired; 5 6 import com.soecode.lyf.BaseTest; 7 import com.soecode.lyf.entity.Appointment; 8 9 public class AppointmentDaoTest extends BaseTest { 10 11 @Autowired 12 private AppointmentDao appointmentDao; 13 14 @Test 15 public void testInsertAppointment() throws Exception { 16 long bookId = 1000; 17 long studentId = 12345678910L; 18 int insert = appointmentDao.insertAppointment(bookId, studentId); 19 System.out.println("insert=" + insert); 20 } 21 22 @Test 23 public void testQueryByKeyWithBook() throws Exception { 24 long bookId = 1000; 25 long studentId = 12345678910L; 26 Appointment appointment = appointmentDao.queryByKeyWithBook(bookId, studentId); 27 System.out.println(appointment); 28 System.out.println(appointment.getBook()); 29 } 30 31 }
AppointmentDaoTest测试结果
testInsertAppointment
testQueryByKeyWithBook
嗯,到这里一切到很顺利~那么我们继续service层的编码吧~可能下面开始信息里比较大,大家要做好心理准备~
首先,在写我们的控制器之前,我们先定义几个预约图书操作返回码的数据字典,也就是我们要返回给客户端的信息。我们这类使用枚举类,没听过的小伙伴要好好恶补一下了(我也是最近才学到的= =)
预约业务操作返回码说明
返回码 | 说明 |
---|---|
1 | 预约成功 |
0 | 库存不足 |
-1 | 重复预约 |
-2 | 系统异常 |
新建一个包叫enums
,在里面新建一个枚举类AppointStateEnum.java
,用来定义预约业务的数据字典,没听懂没关系,我们直接看代码吧~是不是感觉有模有样了!
新建类AppointStateEnum.java
1 package com.soecode.lyf.enums; 2 3 /** 4 * 使用枚举表述常量数据字典 5 */ 6 public enum AppointStateEnum { 7 8 SUCCESS(1, "预约成功"), NO_NUMBER(0, "库存不足"), REPEAT_APPOINT(-1, "重复预约"), INNER_ERROR(-2, "系统异常"); 9 10 private int state; 11 12 private String stateInfo; 13 14 private AppointStateEnum(int state, String stateInfo) { 15 this.state = state; 16 this.stateInfo = stateInfo; 17 } 18 19 public int getState() { 20 return state; 21 } 22 23 public String getStateInfo() { 24 return stateInfo; 25 } 26 27 public static AppointStateEnum stateOf(int index) { 28 for (AppointStateEnum state : values()) { 29 if (state.getState() == index) { 30 return state; 31 } 32 } 33 return null; 34 } 35 36 }
接下来,在dto
包下新建AppointExecution.java
用来存储我们执行预约操作的返回结果。
新建类AppointExecution.java
1 package com.soecode.lyf.dto; 2 3 import com.soecode.lyf.entity.Appointment; 4 import com.soecode.lyf.enums.AppointStateEnum; 5 6 /** 7 * 封装预约执行后结果 8 */ 9 public class AppointExecution { 10 11 // 图书ID 12 private long bookId; 13 14 // 秒杀预约结果状态 15 private int state; 16 17 // 状态标识 18 private String stateInfo; 19 20 // 预约成功对象 21 private Appointment appointment; 22 23 public AppointExecution() { 24 } 25 26 // 预约失败的构造器 27 public AppointExecution(long bookId, AppointStateEnum stateEnum) { 28 this.bookId = bookId; 29 this.state = stateEnum.getState(); 30 this.stateInfo = stateEnum.getStateInfo(); 31 } 32 33 // 预约成功的构造器 34 public AppointExecution(long bookId, AppointStateEnum stateEnum, Appointment appointment) { 35 this.bookId = bookId; 36 this.state = stateEnum.getState(); 37 this.stateInfo = stateEnum.getStateInfo(); 38 this.appointment = appointment; 39 } 40 41 // 省略getter和setter方法,toString方法 42 43 }
接着,在exception
包下新建三个文件 NoNumberException.java
RepeatAppointException.java
AppointException.java
预约业务异常类(都需要继承RuntimeException),分别是无库存异常、重复预约异常、预约未知错误异常,用于业务层非成功情况下的返回(即成功返回结果,失败抛出异常)。
异常类NoNumberException.java
1 package com.soecode.lyf.exception; 2 3 /** 4 * 库存不足异常 5 */ 6 public class NoNumberException extends RuntimeException { 7 8 public NoNumberException(String message) { 9 super(message); 10 } 11 12 public NoNumberException(String message, Throwable cause) { 13 super(message, cause); 14 } 15 16 }
异常类RepeatAppointException.java
1 package com.soecode.lyf.exception; 2 3 /** 4 * 重复预约异常 5 */ 6 public class RepeatAppointException extends RuntimeException { 7 8 public RepeatAppointException(String message) { 9 super(message); 10 } 11 12 public RepeatAppointException(String message, Throwable cause) { 13 super(message, cause); 14 } 15 16 }
异常类AppointException.java
1 package com.soecode.lyf.exception; 2 3 /** 4 * 预约业务异常 5 */ 6 public class AppointException extends RuntimeException { 7 8 public AppointException(String message) { 9 super(message); 10 } 11 12 public AppointException(String message, Throwable cause) { 13 super(message, cause); 14 } 15 16 }
咱们终于可以编写业务代码了,在service
包下新建BookService.java
图书业务接口。
业务层BookService.java
1 package com.soecode.lyf.service; 2 3 import java.util.List; 4 5 import com.soecode.lyf.dto.AppointExecution; 6 import com.soecode.lyf.entity.Book; 7 8 /** 9 * 业务接口:站在"使用者"角度设计接口 三个方面:方法定义粒度,参数,返回类型(return 类型/异常) 10 */ 11 public interface BookService { 12 13 /** 14 * 查询一本图书 15 * 16 * @param bookId 17 * @return 18 */ 19 Book getById(long bookId); 20 21 /** 22 * 查询所有图书 23 * 24 * @return 25 */ 26 List<Book> getList(); 27 28 /** 29 * 预约图书 30 * 31 * @param bookId 32 * @param studentId 33 * @return 34 */ 35 AppointExecution appoint(long bookId, long studentId); 36 37 }
在service.impl
包下新建BookServiceImpl.java
使用BookService
接口,并实现里面的方法。
接口实现BookServiceImpl
1 package com.soecode.lyf.service.impl; 2 3 import java.util.List; 4 5 import org.slf4j.Logger; 6 import org.slf4j.LoggerFactory; 7 import org.springframework.beans.factory.annotation.Autowired; 8 import org.springframework.stereotype.Service; 9 import org.springframework.transaction.annotation.Transactional; 10 11 import com.soecode.lyf.dao.AppointmentDao; 12 import com.soecode.lyf.dao.BookDao; 13 import com.soecode.lyf.dto.AppointExecution; 14 import com.soecode.lyf.entity.Appointment; 15 import com.soecode.lyf.entity.Book; 16 import com.soecode.lyf.enums.AppointStateEnum; 17 import com.soecode.lyf.exception.AppointException; 18 import com.soecode.lyf.exception.NoNumberException; 19 import com.soecode.lyf.exception.RepeatAppointException; 20 import com.soecode.lyf.service.BookService; 21 22 @Service 23 public class BookServiceImpl implements BookService { 24 25 private Logger logger = LoggerFactory.getLogger(this.getClass()); 26 27 // 注入Service依赖 28 @Autowired 29 private BookDao bookDao; 30 31 @Autowired 32 private AppointmentDao appointmentDao; 33 34 35 @Override 36 public Book getById(long bookId) { 37 return bookDao.queryById(bookId); 38 } 39 40 @Override 41 public List<Book> getList() { 42 return bookDao.queryAll(0, 1000); 43 } 44 45 @Override 46 @Transactional 47 /** 48 * 使用注解控制事务方法的优点: 1.开发团队达成一致约定,明确标注事务方法的编程风格 49 * 2.保证事务方法的执行时间尽可能短,不要穿插其他网络操作,RPC/HTTP请求或者剥离到事务方法外部 50 * 3.不是所有的方法都需要事务,如只有一条修改操作,只读操作不需要事务控制 51 */ 52 public AppointExecution appoint(long bookId, long studentId) { 53 try { 54 // 减库存 55 int update = bookDao.reduceNumber(bookId); 56 if (update <= 0) {// 库存不足 57 //return new AppointExecution(bookId, AppointStateEnum.NO_NUMBER);//错误写法 58 throw new NoNumberException("no number"); 59 } else { 60 // 执行预约操作 61 int insert = appointmentDao.insertAppointment(bookId, studentId); 62 if (insert <= 0) {// 重复预约 63 //return new AppointExecution(bookId, AppointStateEnum.REPEAT_APPOINT);//错误写法 64 throw new RepeatAppointException("repeat appoint"); 65 } else {// 预约成功 66 Appointment appointment = appointmentDao.queryByKeyWithBook(bookId, studentId); 67 return new AppointExecution(bookId, AppointStateEnum.SUCCESS, appointment); 68 } 69 } 70 // 要先于catch Exception异常前先catch住再抛出,不然自定义的异常也会被转换为AppointException,导致控制层无法具体识别是哪个异常 71 } catch (NoNumberException e1) { 72 throw e1; 73 } catch (RepeatAppointException e2) { 74 throw e2; 75 } catch (Exception e) { 76 logger.error(e.getMessage(), e); 77 // 所有编译期异常转换为运行期异常 78 //return new AppointExecution(bookId, AppointStateEnum.INNER_ERROR);//错误写法 79 throw new AppointException("appoint inner error:" + e.getMessage()); 80 } 81 } 82 83 }
下面我们来测试一下我们的业务代码吧~因为查询图书的业务不复杂,所以这里只演示我们最重要的预约图书业务!!
测试类BookServiceImplTest.java
1 package com.soecode.lyf.service.impl; 2 3 import static org.junit.Assert.fail; 4 5 import org.junit.Test; 6 import org.springframework.beans.factory.annotation.Autowired; 7 8 import com.soecode.lyf.BaseTest; 9 import com.soecode.lyf.dto.AppointExecution; 10 import com.soecode.lyf.service.BookService; 11 12 public class BookServiceImplTest extends BaseTest { 13 14 @Autowired 15 private BookService bookService; 16 17 @Test 18 public void testAppoint() throws Exception { 19 long bookId = 1001; 20 long studentId = 12345678910L; 21 AppointExecution execution = bookService.appoint(bookId, studentId); 22 System.out.println(execution); 23 } 24 25 }
BookServiceImplTest测试结果
testAppoint
首次执行是“预约成功”,如果再次执行的话,应该会出现“重复预约”,哈哈,我们所有的后台代码都通过单元测试啦~~是不是很开心~
咱们还需要在dto
包里新建一个封装json返回结果的类Result.java
,设计成泛型。
封装结果Result.java
1 package com.soecode.lyf.dto; 2 3 /** 4 * 封装json对象,所有返回结果都使用它 5 */ 6 public class Result<T> { 7 8 private boolean success;// 是否成功标志 9 10 private T data;// 成功时返回的数据 11 12 private String error;// 错误信息 13 14 public Result() { 15 } 16 17 // 成功时的构造器 18 public Result(boolean success, T data) { 19 this.success = success; 20 this.data = data; 21 } 22 23 // 错误时的构造器 24 public Result(boolean success, String error) { 25 this.success = success; 26 this.error = error; 27 } 28 29 // 省略getter和setter方法 30 }
最后,我们写web层,也就是controller,我们在web
包下新建BookController.java
文件。
控制器BookController.java
1 package com.soecode.lyf.web; 2 3 import java.util.List; 4 5 import org.apache.ibatis.annotations.Param; 6 import org.slf4j.Logger; 7 import org.slf4j.LoggerFactory; 8 import org.springframework.beans.factory.annotation.Autowired; 9 import org.springframework.stereotype.Controller; 10 import org.springframework.ui.Model; 11 import org.springframework.web.bind.annotation.PathVariable; 12 import org.springframework.web.bind.annotation.RequestMapping; 13 import org.springframework.web.bind.annotation.RequestMethod; 14 import org.springframework.web.bind.annotation.ResponseBody; 15 16 import com.soecode.lyf.dto.AppointExecution; 17 import com.soecode.lyf.dto.Result; 18 import com.soecode.lyf.entity.Book; 19 import com.soecode.lyf.enums.AppointStateEnum; 20 import com.soecode.lyf.exception.NoNumberException; 21 import com.soecode.lyf.exception.RepeatAppointException; 22 import com.soecode.lyf.service.BookService; 23 24 @Controller 25 @RequestMapping("/book") // url:/模块/资源/{id}/细分 /seckill/list 26 public class BookController { 27 28 private Logger logger = LoggerFactory.getLogger(this.getClass()); 29 30 @Autowired 31 private BookService bookService; 32 33 @RequestMapping(value = "/list", method = RequestMethod.GET) 34 private String list(Model model) { 35 List<Book> list = bookService.getList(); 36 model.addAttribute("list", list); 37 // list.jsp + model = ModelAndView 38 return "list";// WEB-INF/jsp/"list".jsp 39 } 40 41 @RequestMapping(value = "/{bookId}/detail", method = RequestMethod.GET) 42 private String detail(@PathVariable("bookId") Long bookId, Model model) { 43 if (bookId == null) { 44 return "redirect:/book/list"; 45 } 46 Book book = bookService.getById(bookId); 47 if (book == null) { 48 return "forward:/book/list"; 49 } 50 model.addAttribute("book", book); 51 return "detail"; 52 } 53 54 //ajax json 55 @RequestMapping(value = "/{bookId}/appoint", method = RequestMethod.POST, produces = { 56 "application/json; charset=utf-8" }) 57 @ResponseBody 58 private Result<AppointExecution> appoint(@PathVariable("bookId") Long bookId, @RequestParam("studentId") Long studentId) { 59 if (studentId == null || studentId.equals("")) { 60 return new Result<>(false, "学号不能为空"); 61 } 62 //AppointExecution execution = bookService.appoint(bookId, studentId);//错误写法,不能统一返回,要处理异常(失败)情况 63 AppointExecution execution = null; 64 try { 65 execution = bookService.appoint(bookId, studentId); 66 } catch (NoNumberException e1) { 67 execution = new AppointExecution(bookId, AppointStateEnum.NO_NUMBER); 68 } catch (RepeatAppointException e2) { 69 execution = new AppointExecution(bookId, AppointStateEnum.REPEAT_APPOINT); 70 } catch (Exception e) { 71 execution = new AppointExecution(bookId, AppointStateEnum.INNER_ERROR); 72 } 73 return new Result<AppointExecution>(true, execution); 74 } 75 76 }
因为我比较懒,所以我们就不测试controller了,好讨厌写前端,呜呜呜~
到此,我们的SSM框架整合配置,与应用实例部分已经结束了。
补充
2018-02-28更新:
修改预约业务代码,失败时抛异常,成功时才返回结果,控制层根据捕获的异常返回相应信息给客户端,而不是业务层直接返回错误结果。上面的代码已经作了修改,而且错误示范也注释保留着,之前误人子弟了,还好有位网友前几天提出质疑,我也及时做了修改。
2018-03-30更新:
修改BookController几处错误
1.detail方法不是返回json的,故不用加@ResponseBody注解
2.appoint方法应该加上@ResponseBody注解
3.另外studentId参数注解应该是@RequestParam
4.至于controller测试,测试appoint方法可不必写jsp,用curl就行,比如
curl -H “Accept: application/json; charset=utf-8” -d “studentId=1234567890” localhost:8080/book/1003/appoint