我們看招聘信息的時候,經常會看到這一點,需要具備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