7player
基於SpringBoot + Mybatis實現SpringMVC Web項目【原創】
一、熱身
一個現實的場景是：當我們開發一個Web工程時，架構師和開發工程師可能更關心項目技術結構上的設計。而幾乎所有結構良好的軟件（項目）都使用了分層設計。分層設計是將項目按技術職能分為幾個內聚的部分，從而將技術或接口的實現細節隱藏起來。
從另一個角度上來看，結構上的分層往往也能促進了技術人員的分工，可以使開發人員更專注於某一層業務與功能的實現，比如前端工程師只關心頁面的展示與交互效果（例如專注於HTML，JS等），而后端工程師只關心數據和業務邏輯的處理（專注於Java，Mysql等）。兩者之間通過標准接口（協議）進行溝通。
在實現分層的過程中我們會使用一些框架，例如SpringMVC。但利用框架帶來了一些使用方面的問題。我們經常要做的工作就是配置各種XML文件，然后還需要搭建配置Tomcat或者Jetty作為容器來運行這個工程。每次構建一個新項目，都要經歷這個流程。更為不幸的是有時候前端人員為了能在本地調試或測試程序，也需要先配置這些環境，或者需要后端人員先實現一些服務功能。這就和剛才提到的“良好的分層結構”相沖突。
每一種技術和框架都有一定的學習曲線。開發人員需要了解具體細節，才知道如何把項目整合成一個完整的解決方案。事實上，一個整合良好的項目框架不僅僅能實現技術、業務的分離，還應該關注並滿足開發人員的“隔離”。
為了解決此類問題，便產生了Spring Boot這一全新框架。Spring Boot就是用來簡化Spring應用的搭建以及開發過程。該框架致力於實現免XML配置，提供便捷，獨立的運行環境，實現“一鍵運行”滿足快速應用開發的需求。
與此同時，一個完整的Web應用難免少不了數據庫的支持。利用JDBC的API需要編寫復雜重復且冗余的代碼。而使用O/RM（例如Hibernate）工具需要基於一些假設和規則，例如最普遍的一個假設就是數據庫被恰當的規范了。這些規范在現實項目中並非能完美實現。由此，誕生了一種混合型解決方案——Mybatis。Mybatis是一個持久層框架，它從各種數據庫訪問工具中汲取大量優秀的思想，適用於任何大小和用途的數據庫。根據官方文檔的描述：MyBatis 是支持定制化 SQL、存儲過程以及高級映射的優秀的持久層框架。MyBatis 避免了幾乎所有的 JDBC 代碼和手動設置參數以及獲取結果集。MyBatis 可以對配置和原生Map使用簡單的 XML 或注解，將接口和 Java 的 POJOs(Plain Old Java Objects，普通的 Java對象)映射成數據庫中的記錄。
最后，再回到技術結構分層上，目前主流倡導的設計模式為MVC，即模型(model)－視圖(view)－控制器(controller)。實現該設計模式的框架有很多，例如Struts。而前文提到的SpringMVC是另一個更為優秀，靈活易用的MVC框架。 SpringMVC是一種基於Java的以請求為驅動類型的輕量級Web框架，其目的是將Web層進行解耦，即使用“請求-響應”模型，從工程結構上實現良好的分層，區分職責，簡化Web開發。
目前，對於如何把這些技術整合起來形成一個完整的解決方案，並沒有相關的最佳實踐。將Spring Boot和Mybatis兩者整合使用的資料和案例較少。因此，本文提供（介紹）一個完整利用SpringBoot和Mybatis來構架Web項目的案例。該案例基於SpringMVC架構提供完整且簡潔的實現Demo，便於開發人員根據不同需求和業務進行拓展。
補充提示，Spring Boot 推薦采用基於 Java 注解的配置方式，而不是傳統的 XML。只需要在主配置 Java 類上添加“@EnableAutoConfiguration”注解就可以啟用自動配置。Spring Boot 的自動配置功能是沒有侵入性的，只是作為一種基本的默認實現。開發人員可以通過定義其他 bean 來替代自動配置所提供的功能，例如在配置本案例數據源（DataSource）時，可以體會到該用法。
二、實踐
一些說明：
項目IDE采用Intellij（主要原因在於Intellij顏值完爆Eclipse，誰叫這是一個看臉的時代）
工程依賴管理采用個人比較熟悉的Maven（事實上SpringBoot與Groovy才是天生一對）
1.預覽：
（1）github地址
（2）完整項目結構
（3）數據庫
數據庫名：test
【user.sql】
SET FOREIGN_KEY_CHECKS=0;
-- ----------------------------
-- Table structure for user
-- ----------------------------
DROP TABLE IF EXISTS `user`;
CREATE TABLE `user` (
`id` int(11) NOT NULL,
`name` varchar(255) DEFAULT NULL,
`age` int(11) DEFAULT NULL,
`password` varchar(255) DEFAULT NULL,
PRIMARY KEY (`id`)
) ENGINE=InnoDB DEFAULT CHARSET=latin1;
-- ----------------------------
-- Records of user
-- ----------------------------
INSERT INTO `user` VALUES ('1', '7player', '18', '123456');
2.Maven配置
完整的【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>cn.7player.framework</groupId>
<artifactId>springboot-mybatis</artifactId>
<version>1.0-SNAPSHOT</version>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>1.2.5.RELEASE</version>
</parent>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<java.version>1.7</java.version>
</properties>
<dependencies>
<!--Spring Boot-->
<!--支持 Web 應用開發，包含 Tomcat 和 spring-mvc。 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-web</artifactId>
</dependency>
<!--模板引擎-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-thymeleaf</artifactId>
</dependency>
<!--支持使用 JDBC 訪問數據庫-->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-jdbc</artifactId>
</dependency>
<!--添加適用於生產環境的功能，如性能指標和監測等功能。 -->
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-actuator</artifactId>
</dependency>
<!--Mybatis-->
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis-spring</artifactId>
<version>1.2.2</version>
</dependency>
<dependency>
<groupId>org.mybatis</groupId>
<artifactId>mybatis</artifactId>
<version>3.2.8</version>
</dependency>
<!--Mysql / DataSource-->
<dependency>
<groupId>org.apache.tomcat</groupId>
<artifactId>tomcat-jdbc</artifactId>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
<!--Json Support-->
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>fastjson</artifactId>
<version>1.1.43</version>
</dependency>
<!--Swagger support-->
<dependency>
<groupId>com.mangofactory</groupId>
<artifactId>swagger-springmvc</artifactId>
<version>0.9.5</version>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
</plugin>
</plugins>
</build>
<repositories>
<repository>
<id>spring-milestone</id>
<url>https://repo.spring.io/libs-release</url>
</repository>
</repositories>
<pluginRepositories>
<pluginRepository>
<id>spring-milestone</id>
<url>https://repo.spring.io/libs-release</url>
</pluginRepository>
</pluginRepositories>
</project>
3.主函數
【Application.java】包含main函數，像普通java程序啟動即可。
此外，該類中還包含和數據庫相關的DataSource，SqlSeesion配置內容。
注：@MapperScan(“cn.no7player.mapper”) 表示Mybatis的映射路徑（package路徑）
package cn.no7player;
import org.apache.ibatis.session.SqlSessionFactory;
import org.apache.log4j.Logger;
import org.mybatis.spring.SqlSessionFactoryBean;
import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.ComponentScan;
import org.springframework.core.io.support.PathMatchingResourcePatternResolver;
import org.springframework.jdbc.datasource.DataSourceTransactionManager;
import org.springframework.transaction.PlatformTransactionManager;
import javax.sql.DataSource;
@EnableAutoConfiguration
@SpringBootApplication
@ComponentScan
@MapperScan("cn.no7player.mapper")
public class Application {
private static Logger logger = Logger.getLogger(Application.class);
//DataSource配置
@Bean
@ConfigurationProperties(prefix="spring.datasource")
public DataSource dataSource() {
return new org.apache.tomcat.jdbc.pool.DataSource();
}
//提供SqlSeesion
@Bean
public SqlSessionFactory sqlSessionFactoryBean() throws Exception {
SqlSessionFactoryBean sqlSessionFactoryBean = new SqlSessionFactoryBean();
sqlSessionFactoryBean.setDataSource(dataSource());
PathMatchingResourcePatternResolver resolver = new PathMatchingResourcePatternResolver();
sqlSessionFactoryBean.setMapperLocations(resolver.getResources("classpath:/mybatis/*.xml"));
return sqlSessionFactoryBean.getObject();
}
@Bean
public PlatformTransactionManager transactionManager() {
return new DataSourceTransactionManager(dataSource());
}
/**
* Main Start
*/
public static void main(String[] args) {
SpringApplication.run(Application.class, args);
logger.info("============= SpringBoot Start Success =============");
}
}
4.Controller
請求入口Controller部分提供三種接口樣例：視圖模板，Json，restful風格
（1）視圖模板
返回結果為視圖文件路徑。視圖相關文件默認放置在路徑 resource/templates下：
package cn.no7player.controller;
import org.apache.log4j.Logger;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
@Controller
public class HelloController {
private Logger logger = Logger.getLogger(HelloController.class);
/*
* http://localhost:8080/hello?name=cn.7player
*/
@RequestMapping("/hello")
public String greeting(@RequestParam(value="name", required=false, defaultValue="World") String name, Model model) {
logger.info("hello");
model.addAttribute("name", name);
return "hello";
}
}
（2）Json
返回Json格式數據，多用於Ajax請求。
package cn.no7player.controller;
import cn.no7player.model.User;
import cn.no7player.service.UserService;
import org.apache.log4j.Logger;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;
@Controller
public class UserController {
private Logger logger = Logger.getLogger(UserController.class);
@Autowired
private UserService userService;
/*
* http://localhost:8080/getUserInfo
*/
@RequestMapping("/getUserInfo")
@ResponseBody
public User getUserInfo() {
User user = userService.getUserInfo();
if(user!=null){
System.out.println("user.getName():"+user.getName());
logger.info("user.getAge():"+user.getAge());
}
return user;
}
}
（3）restful
REST 指的是一組架構約束條件和原則。滿足這些約束條件和原則的應用程序或設計就是 RESTful。
此外，有一款RESTFUL接口的文檔在線自動生成+功能測試功能軟件——Swagger UI，具體配置過程可移步《Spring Boot 利用 Swagger 實現restful測試》
package cn.no7player.controller;
import cn.no7player.model.User;
import com.wordnik.swagger.annotations.ApiOperation;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;
import java.util.ArrayList;
import java.util.List;
@RestController
@RequestMapping(value="/users")
public class SwaggerController {
/*
* http://localhost:8080/swagger/index.html
*/
@ApiOperation(value="Get all users",notes="requires noting")
@RequestMapping(method=RequestMethod.GET)
public List<User> getUsers(){
List<User> list=new ArrayList<User>();
User user=new User();
user.setName("hello");
list.add(user);
User user2=new User();
user.setName("world");
list.add(user2);
return list;
}
@ApiOperation(value="Get user with id",notes="requires the id of user")
@RequestMapping(value="/{name}",method=RequestMethod.GET)
public User getUserById(@PathVariable String name){
User user=new User();
user.setName("hello world");
return user;
}
}
5.Mybatis
配置相關代碼在Application.java中體現。
（1）【application.properties】
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/test?useUnicode=true&characterEncoding=gbk&zeroDateTimeBehavior=convertToNull spring.datasource.username=root spring.datasource.password=123456 spring.datasource.driver-class-name=com.mysql.jdbc.Driver
注意，在Application.java代碼中，配置DataSource時的注解
@ConfigurationProperties(prefix=“spring.datasource”)
表示將根據前綴“spring.datasource”從application.properties中匹配相關屬性值。
（2）【UserMapper.xml】
Mybatis的sql映射文件。Mybatis同樣支持注解方式，在此不予舉例了。
<?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="cn.no7player.mapper.UserMapper">
<select id="findUserInfo" resultType="cn.no7player.model.User">
select name, age,password from user;
</select>
</mapper>
（3）接口UserMapper
package cn.no7player.mapper;
import cn.no7player.model.User;
public interface UserMapper {
public User findUserInfo();
}
三、總結
（1）運行 Application.java
（2）控制台輸出：
…..（略過無數內容）
http://localhost:8080/getUserInfo
Restful（使用了swagger）：
四、參閱
《Spring Boot – Quick Start》
http://projects.spring.io/spring-boot/#quick-start
《mybatis》
http://mybatis.github.io/mybatis-3/
《使用 Spring Boot 快速構建 Spring 框架應用》
http://www.ibm.com/developerworks/cn/java/j-lo-spring-boot/
《Using @ConfigurationProperties in Spring Boot》
《Springboot-Mybatis-Mysample》
https://github.com/mizukyf/springboot-mybatis-mysample
《Serving Web Content with Spring MVC》
http://spring.io/guides/gs/serving-web-content/
《理解RESTful架構》
http://www.ruanyifeng.com/blog/2011/09/restful
附錄：
Spring Boot 推薦的基礎 POM 文件
| 名稱 |
說明 |
| spring-boot-starter |
核心 POM，包含自動配置支持、日志庫和對 YAML 配置文件的支持。 |
| spring-boot-starter-amqp |
通過 spring-rabbit 支持 AMQP。 |
| spring-boot-starter-aop |
包含 spring-aop 和 AspectJ 來支持面向切面編程（AOP）。 |
| spring-boot-starter-batch |
支持 Spring Batch，包含 HSQLDB。 |
| spring-boot-starter-data-jpa |
包含 spring-data-jpa、spring-orm 和 Hibernate 來支持 JPA。 |
| spring-boot-starter-data-mongodb |
包含 spring-data-mongodb 來支持 MongoDB。 |
| spring-boot-starter-data-rest |
通過 spring-data-rest-webmvc 支持以 REST 方式暴露 Spring Data 倉庫。 |
| spring-boot-starter-jdbc |
支持使用 JDBC 訪問數據庫。 |
| spring-boot-starter-security |
包含 spring-security。 |
| spring-boot-starter-test |
包含常用的測試所需的依賴，如 JUnit、Hamcrest、Mockito 和 spring-test 等。 |
| spring-boot-starter-velocity |
支持使用 Velocity 作為模板引擎。 |
| spring-boot-starter-web |
支持 Web 應用開發，包含 Tomcat 和 spring-mvc。 |
| spring-boot-starter-websocket |
支持使用 Tomcat 開發 WebSocket 應用。 |
| spring-boot-starter-ws |
支持 Spring Web Services。 |
| spring-boot-starter-actuator |
添加適用於生產環境的功能，如性能指標和監測等功能。 |
| spring-boot-starter-remote-shell |
添加遠程 SSH 支持。 |
| spring-boot-starter-jetty |
使用 Jetty 而不是默認的 Tomcat 作為應用服務器。 |
| spring-boot-starter-log4j |
添加 Log4j 的支持。 |
| spring-boot-starter-logging |
使用 Spring Boot 默認的日志框架 Logback。 |
| spring-boot-starter-tomcat |
使用 Spring Boot 默認的 Tomcat 作為應用服務器。 |
15 條評論
近期文章
近期評論
- 匿名發表在《案例學習 Java8 Lambda函數式編程》
- 匿名發表在《基於SpringBoot + Mybatis實現SpringMVC Web項目【原創】》
- 匿名發表在《基於SpringBoot + Mybatis實現SpringMVC Web項目【原創】》
- 匿名發表在《案例學習 Java8 Lambda函數式編程》
- 匿名發表在《基於SpringBoot + Mybatis實現SpringMVC Web項目【原創】》
標簽雲
Views
- 基於SpringBoot + Mybatis實現SpringMVC Web項目【原創】- 21,567 views
- tomcat部署根目錄- 9,633 views
- Linux上Json庫的安裝- 9,375 views
- Struts2 開發步驟 教程（MyEclipse ）- 5,005 views
- 天空藍得自由——談談夢想【原創】- 2,707 views
- intellij 快捷鍵 大全- 2,646 views
- 基於Maven搭建Spring + Hibernate + Struts2項目【原創】- 2,348 views
- 愛情小說 之 筆名【原創】- 2,072 views
- 2015 神州通付（成都）年會主持稿（整理+圖）- 1,418 views
- Intellij 創建Maven項目- 1,396 views
| 一 | 二 | 三 | 四 | 五 | 六 | 日 |
|---|---|---|---|---|---|---|
| « 七 | 二 » | |||||
| 1 | 2 | |||||
| 3 | 4 | 5 | 6 | 7 | 8 | 9 |
| 10 | 11 | 12 | 13 | 14 | 15 | 16 |
| 17 | 18 | 19 | 20 | 21 | 22 | 23 |
| 24 | 25 | 26 | 27 | 28 | 29 | 30 |
| 31 | ||||||
講解 很詳細 也很實用 贊一個
多謝！講解非常詳細。
是啊剛進公司用的springboot，為什么用java -jar運行啊，懵啊
寫的很棒。不過感覺還是離真實web項目遠了一點。為什么都是采用java -jar的方式來運行的？能不能談一下用eclipse如何創建web項目呢？如何run on a server,如何調試？
springboot就是這個寫法啊，我們公司的web都是用這個弄的，
我們公司也是用的這個框架，很棒的！
service層和mapper沒有展示出來，代碼不全
好吧 我看錯了 后面有接口和mapper
謝謝您的項目啊
沒有事務控制
我下的源碼，為什么我本地數據庫連不上呢
注意看下 本地數據庫的用戶名和密碼配置是否和源碼一致？
我就差一點,現在按照你的老是報錯想看看你的代碼是怎么寫的,發給我吧,謝謝了627266375@qq.com
能把你的源碼打包提供出來嗎(包可以刪掉)?感激不盡,發我郵箱也可以謝謝了,627266375@qq.com
雖然完全沒看懂在說什么(實際上是完全沒看)，但是還是有必要搶個沙發坐坐