前言:
spring+springmvc+mybatis,稱為ssm。ssm可以說是後端程式員必備技能,應該也是目前用得最多的,是以無論如何都要掌握!下面一起來看整合案例。點
我下載下傳源碼。
開發環境:
1、開發工具:eclipse 4.7.3
2、maven 3.5.2
3、jdk 1.9
4、tomcat 8.5
5、mysql 5.7.21
一、項目環境搭建:
1、建立項目:
打開eclipse,file --> new --> maven project --> maven archetype webapp,然後填寫好artifactId,點finish即可。若是建立maven項目失敗,請參考
eclipse建立maven項目失敗解決方法2、建立項目目錄結構:
建立好項目以後,按照下圖建立項目結構:
圖檔發自簡書App
注意:項目剛建立出來可能隻有src/main/java,自己建立其他的時候是 new source folder,而不是package。
3、添加依賴:
接下來就是添加依賴,本案例需要如下依賴:
<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/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>com.zhu</groupId>
<artifactId>ssm</artifactId>
<packaging>war</packaging>
<version>0.0.1-SNAPSHOT</version>
<name>ssm Maven Webapp</name>
<url>http://maven.apache.org</url>
<dependencies>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.12</version>
<scope>test</scope>
</dependency>
<!-- https://mvnrepository.com/artifact/org.springframework/spring-core -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-core</artifactId>
<version>4.3.14.RELEASE</version>
</dependency>
<!-- https://mvnrepository.com/artifact/org.springframework/spring-beans -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-beans</artifactId>
<version>4.3.14.RELEASE</version>
</dependency>
<!-- https://mvnrepository.com/artifact/org.springframework/spring-context -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context</artifactId>
<version>4.3.14.RELEASE</version>
</dependency>
<!-- https://mvnrepository.com/artifact/org.springframework/spring-jdbc -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-jdbc</artifactId>
<version>4.3.14.RELEASE</version>
</dependency>
<!-- https://mvnrepository.com/artifact/org.springframework/spring-tx -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-tx</artifactId>
<version>4.3.14.RELEASE</version>
</dependency>
<!-- https://mvnrepository.com/artifact/org.springframework/spring-web -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-web</artifactId>
<version>4.3.14.RELEASE</version>
</dependency>
<!-- https://mvnrepository.com/artifact/org.springframework/spring-webmvc -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-webmvc</artifactId>
<version>4.3.14.RELEASE</version>
</dependency>
<!-- https://mvnrepository.com/artifact/org.springframework/spring-test -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-test</artifactId>
<version>4.3.14.RELEASE</version>
<scope>test</scope>
</dependency>
<!-- https://mvnrepository.com/artifact/javax.servlet/javax.servlet-api -->
<dependency>
<groupId>javax.servlet</groupId>
<artifactId>javax.servlet-api</artifactId>
<version>3.1.0</version>
<scope>provided</scope>
</dependency>
<!-- https://mvnrepository.com/artifact/com.fasterxml.jackson.core/jackson-databind -->
<dependency>
<groupId>com.fasterxml.jackson.core</groupId>
<artifactId>jackson-databind</artifactId>
<version>2.8.7</version>
</dependency>
<!-- https://mvnrepository.com/artifact/commons-collections/commons-collections -->
<dependency>
<groupId>commons-collections</groupId>
<artifactId>commons-collections</artifactId>
<version>3.2</version>
</dependency>
<!-- https://mvnrepository.com/artifact/org.mybatis/mybatis -->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.4.2</version>
</dependency>
<!-- https://mvnrepository.com/artifact/org.mybatis/mybatis-spring -->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis-spring</artifactId>
<version>1.3.1</version>
</dependency>
<!-- https://mvnrepository.com/artifact/mysql/mysql-connector-java -->
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
<version>5.1.37</version>
</dependency>
<!-- https://mvnrepository.com/artifact/com.mchange/c3p0 -->
<dependency>
<groupId>com.mchange</groupId>
<artifactId>c3p0</artifactId>
<version>0.9.5.2</version>
</dependency>
>> </dependencies>
<build>
<finalName>ssm</finalName>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<version>3.6.1</version>
</plugin>
</plugins>
</build>
</project>
4、完成各項配置:
添加好依賴之後,就來完成jdbc資料源、mybatis和spring 的配置:
jdbc.properties
jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql:///ssm?useUnicode=true&characterEncoding=utf8
jdbc.username=#
jdbc.password=#
mybatis-config.xml
<?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" />
<!-- 使用列别名替換列名 -->
<!-- <setting name="useColumnLabel" value="true"/> -->
<!-- 開啟駝峰命名轉換(userId === user_id) -->
<setting name="mapUnderscoreToCamelCase" value="true" />
</settings>
<!-- 取别名,比如一個方法中傳回值類型是User,
配置了這個在 parameterType屬性中就不用寫User的全類名,
直接寫User即可,可以在這裡配置,也可以再spring配置檔案中配置 -->
<!-- <typeAliases> <package name="com.zhu.smm.entity"/> </typeAliases> -->
</configuration>
src/main/resource/spring下有如下三個配置檔案,分别配置dao層,service層,controller層:
spring-dao.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:p="http://www.springframework.org/schema/p"
xmlns:aop="http://www.springframework.org/schema/aop"
xmlns:context="http://www.springframework.org/schema/context"
xmlns:jee="http://www.springframework.org/schema/jee"
xmlns:tx="http://www.springframework.org/schema/tx"
xsi:schemaLocation="
http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-4.0.xsd
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.0.xsd
http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.0.xsd
http://www.springframework.org/schema/jee http://www.springframework.org/schema/jee/spring-jee-4.0.xsd
http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-4.0.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、配置mybatis的sqlSessionFactory -->
<bean id="sqlSessionFactory" class="org.mybatis.spring.SqlSessionFactoryBean">
<property name="dataSource" ref="dataSource" />
<!-- 自動掃描mappers.xml檔案 -->
<property name="mapperLocations" value="classpath:mapper/*.xml"/>
<!-- 掃描mybatis-config檔案 -->
<property name="configLocation" value="classpath:mybatis-config.xml"/>
<!-- 掃描entity包,使用别名,或者在mybatis-config中配置,二選一 -->
<property name="typeAliasesPackage" value="com.zhu.ssm.entity"></property>
</bean>
<!-- 4、DAO接口所在包名,Spring會自動查找其下的類 -->
<bean class="org.mybatis.spring.mapper.MapperScannerConfigurer">
<property name="basePackage" value="com.zhu.ssm.dao" />
<property name="sqlSessionFactoryBeanName" value="sqlSessionFactory"></property>
</bean>
</beans>
spring-service.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:p="http://www.springframework.org/schema/p"
xmlns:aop="http://www.springframework.org/schema/aop"
xmlns:context="http://www.springframework.org/schema/context"
xmlns:jee="http://www.springframework.org/schema/jee"
xmlns:tx="http://www.springframework.org/schema/tx"
xsi:schemaLocation="
http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-4.0.xsd
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.0.xsd
http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.0.xsd
http://www.springframework.org/schema/jee http://www.springframework.org/schema/jee/spring-jee-4.0.xsd
http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-4.0.xsd">
<!-- 掃描service包下所有使用注解的類型 -->
<context:component-scan base-package="com.zhu.ssm.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
<?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:p="http://www.springframework.org/schema/p"
xmlns:aop="http://www.springframework.org/schema/aop" xmlns:context="http://www.springframework.org/schema/context"
xmlns:jee="http://www.springframework.org/schema/jee" xmlns:tx="http://www.springframework.org/schema/tx"
xmlns:mvc="http://www.springframework.org/schema/mvc"
xsi:schemaLocation="
http://www.springframework.org/schema/mvc
http://www.springframework.org/schema/mvc/spring-mvc-3.0.xsd
http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-4.0.xsd
http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-4.0.xsd
http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-4.0.xsd
http://www.springframework.org/schema/jee http://www.springframework.org/schema/jee/spring-jee-4.0.xsd
http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-4.0.xsd">
<!-- 配置springmvc -->
<!-- 1、開啟springMvc注解模式 -->
<mvc:annotation-driven />
<context:component-scan base-package="com.zhu.ssm.controller"/>
</beans>
注意:spring-web.xml中還可以配置視圖解析器、檔案上傳器、靜态資源的處理等,因為本案例未涉及這些内容,是以沒有配置。
5、對web.xml進行配置
需要在web.xml中進行如下配置,讓web容器能夠加載到spring的配置檔案:
<!DOCTYPE web-app PUBLIC
"-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
"http://java.sun.com/dtd/web-app_2_3.dtd" >
<web-app>
<display-name>Archetype Created Web Application</display-name>
<servlet>
<servlet-name>spring-dispatcher</servlet-name>
<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
<init-param>
<param-name>contextConfigLocation</param-name>
<param-value>classpath:spring/spring-.xml</param-value>
</init-param>
</servlet>
<servlet-mapping>
<servlet-name>spring-dispatcher</servlet-name>
<url-pattern>/</url-pattern>
</servlet-mapping>
</web-app>
至此,就完成了環境的搭建了,接下來就可以進行代碼的編寫了!
二、分層編寫代碼:
1、entity層:
User.java
public class User {
private Integer userId;
private String userName;
private Integer age;
private Card card;//一個人一張身份證,1對1
private List<MobilePhone> mobilePhone;//土豪,多個手機,1對多
}
Card.java
public class Card {
private Integer cardId;
private String cardNum;//身份證号
private String address;//位址
}
MobilePhone.java
public class MobilePhone {
private Integer mobilePhoneId;
private String brand;//品牌
private double price;//價格
private User user;//主人
}
注意:以上實體類均省略了set和get方法。
2、資料庫設計:
借助資料庫用戶端工具navicat進行資料庫以及表的建立。
tb_mobile_phone中以user_id作為外鍵關聯tu_user,tb_user中以card_id作為外鍵關聯tb_card。
3、dao層:
UserDao.java
/**
* 帶條件分頁查詢:
* 可輸入的條件:名字(模糊),cardId,age,
* @param userCondition 把條件封裝成一個user對象
* @param rowIndex 表示從第幾行開始取資料
* @param pageSize 表示要傳回多少行資料
* @return 傳回user清單
*/
List<User> queryUserList(@Param("userCondition") User userCondition, @Param("rowIndex") int rowIndex,
@Param("pageSize") int pageSize);
UserDao.xml
<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE mapper
PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.zhu.ssm.dao.UserDao">
<resultMap type="User" id="userMap">
<id property="userId" column="user_id"/>
<result property="userName" column="user_name"/>
<result property="age" column="age"/>
<association property="card" column="card_id" javaType="Card">
<id property="cardId" column="card_id"/>
<result property="cardNum" column="card_num"/>
<result property="address" column="address"/>
</association>
<collection property="mobilePhone" column="user_id" ofType="MobilePhone">
<id column="mobile_phone_id" property="mobilePhoneId" />
<result column="brand" property="brand" />
<result column="price" property="price" />
</collection>
</resultMap>
<!-- 帶條件分頁查詢 -->
<select id="queryUserList" resultMap="userMap">
SELECT
u.user_name,u.age,u.card_id,c.card_num,c.address,m.brand,m.price
FROM
tb_user u,tb_card c,tb_mobile_phone m
<where>
<if
test="userCondition.card != null
and
userCondition.card.cardId != null">
and u.card_id =
#{userCondition.card.cardId}
</if>
<if test="userCondition.userName != null">
and u.user_name like '%${userCondition.userName}%'
</if>
<if test="userCondition.age != null">
and u.age = #{userCondition.age}
</if>
AND
u.card_id = c.card_id
AND
u.user_id = m.user_id
</where>
LIMIT #{rowIndex},#{pageSize}
</select>
</mapper>
dao層的帶條件分頁查詢用到了mybatis的動态sql,對動态sql不熟悉的請參考:
mybatis筆記整理養成良好習慣,寫完dao應該做個Junit測試:
BaseTest.java
/**
* 初始化spring各項配置的
* @author zhu
*
*/
@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration({"classpath:spring/spring-dao.xml","classpath:spring/spring-service.xml"})
public class BaseTest {
}
注意:BaseTest.java是用來加載spring配置檔案的。
UserDaoTest.java
public class UserDaoTest extends BaseTest {
@Autowired
private UserDao userDao;
@Test
public void testQueryUserList() {
User userCondition = new User();
/*Card c = new Card();
c.setCardId(2);
userCondition.setCard(c);*/
//userCondition.setAge(22);
userCondition.setUserName("菲");
List<User> ul = userDao.queryUserList(userCondition, 1, 99);
for(User user : ul) {
System.out.println(user.getUserName());
/*List<MobilePhone> list = new ArrayList<>();
list = user.getMobilePhone();
for(MobilePhone mp : list) {
System.out.println(mp.getBrand());
}*/
}
}
}
userCondition設定了userName一個"菲"字,就是模糊查詢名字中帶"菲"字的使用者。
先看資料庫表中的資料:
資料表中名字帶"菲"字的使用者隻有"劉亦菲",正常運作的話應該輸出"劉亦菲"。
再看運作結果:
在控制台輸出了"劉亦菲",符合預期,測試通過。
4、service層:
UserService.java
public interface UserService {
/**
* 帶條件分頁查詢:
* 可輸入的條件:名字(模糊),cardId,age,
* @param userCondition 把條件封裝成一個user對象
* @param rowIndex 表示從第幾行開始取資料
* @param pageSize 表示要傳回多少行資料
* @return 傳回user清單
/
List<User> queryUserList(@Param("userCondition") User userCondition, @Param("rowIndex") int rowIndex,
@Param("pageSize") int pageSize);
}
UserServiceImpl.java
@Service
public class UserServiceImpl implements UserService {
@Autowired
private UserDao userDao;
@Override
public List<User> queryUserList(User userCondition, int rowIndex, int pageSize) {
// TODO Auto-generated method stub
return userDao.queryUserList(userCondition, rowIndex, pageSize);
}
}
由于service層隻是簡單的調用了dao層,這裡不再做Junit測試。
5、controller層:
UserController.java
@Controller
@RequestMapping("/user")
public class UserController {
@Autowired
private UserService userService;
@RequestMapping(value = "/listusers", method = RequestMethod.GET)
@ResponseBody
public Map<String, Object> listUsers() {
Map<String, Object> modelMap = new HashMap<>();
User userCondition = new User();
List<User> userList = userService.queryUserList(userCondition, 1, 99);
modelMap.put("userList", userList);
return modelMap;
}
}
至此,已完成所有代碼。接下來,在浏覽器輸入:
localhost:8080/ssm/user/listusers
在頁面就可以看到通路結果了:
注意:
圖檔中有幾個值為null,是因為查詢UserDao.xml中寫查詢語句時并沒有查這幾個字段,自己加上就行了。
總結:
常見問題:
1、做測試的時候一定要在BaseTest中加載spring 配置檔案,其他test在繼承BaseTest。
2、一定不要忘記web.xml中的配置,且路徑一定要寫對,否則web容器加載不到spring 配置檔案,通路controller時會報404錯誤。
3、由于tb_user中的card_id作為外鍵關聯了tb_card,是以為user設定card時,cardId一定得是tb_card中存在的,否則會報錯,user_id也是tb_mobile_phone的外鍵,同樣的道理。