一個現(xiàn)實的場景是:當我們開發(fā)一個Web工程時,架構師和開發(fā)工程師可能更關心項目技術結構上的設計。而幾乎所有結構良好的軟件(項目)都使用了分層設計。分層設計是將項目按技術職能分為幾個內(nèi)聚的部分,從而將技術或接口的實現(xiàn)細節(jié)隱藏起來。
從另一個角度上來看,結構上的分層往往也能促進了技術人員的分工,可以使開發(fā)人員更專注于某一層業(yè)務與功能的實現(xiàn),比如前端工程師只關心頁面的展示與交互效果(例如專注于HTML,JS等),而后端工程師只關心數(shù)據(jù)和業(yè)務邏輯的處理(專注于Java,Mysql等)。兩者之間通過標準接口(協(xié)議)進行溝通。
在實現(xiàn)分層的過程中我們會使用一些框架,例如SpringMVC。但利用框架帶來了一些使用方面的問題。我們經(jīng)常要做的工作就是配置各種XML文件,然后還需要搭建配置Tomcat或者Jetty作為容器來運行這個工程。每次構建一個新項目,都要經(jīng)歷這個流程。更為不幸的是有時候前端人員為了能在本地調(diào)試或測試程序,也需要先配置這些環(huán)境,或者需要后端人員先實現(xiàn)一些服務功能。這就和剛才提到的“良好的分層結構”相沖突。
每一種技術和框架都有一定的學習曲線。開發(fā)人員需要了解具體細節(jié),才知道如何把項目整合成一個完整的解決方案。事實上,一個整合良好的項目框架不僅僅能實現(xiàn)技術、業(yè)務的分離,還應該關注并滿足開發(fā)人員的“隔離”。
為了解決此類問題,便產(chǎn)生了Spring Boot這一全新框架。Spring Boot就是用來簡化Spring應用的搭建以及開發(fā)過程。該框架致力于實現(xiàn)免XML配置,提供便捷,獨立的運行環(huán)境,實現(xiàn)“一鍵運行”滿足快速應用開發(fā)的需求。
與此同時,一個完整的Web應用難免少不了數(shù)據(jù)庫的支持。利用JDBC的API需要編寫復雜重復且冗余的代碼。而使用O/RM(例如Hibernate)工具需要基于一些假設和規(guī)則,例如最普遍的一個假設就是數(shù)據(jù)庫被恰當?shù)囊?guī)范了。這些規(guī)范在現(xiàn)實項目中并非能完美實現(xiàn)。由此,誕生了一種混合型解決方案——Mybatis。Mybatis是一個持久層框架,它從各種數(shù)據(jù)庫訪問工具中汲取大量優(yōu)秀的思想,適用于任何大小和用途的數(shù)據(jù)庫。根據(jù)官方文檔的描述:MyBatis 是支持定制化 SQL、存儲過程以及高級映射的優(yōu)秀的持久層框架。MyBatis 避免了幾乎所有的 JDBC 代碼和手動設置參數(shù)以及獲取結果集。MyBatis 可以對配置和原生Map使用簡單的 XML 或注解,將接口和 Java 的 POJOs(Plain Old Java Objects,普通的 Java對象)映射成數(shù)據(jù)庫中的記錄。
最后,再回到技術結構分層上,目前主流倡導的設計模式為MVC,即模型(model)-視圖(view)-控制器(controller)。實現(xiàn)該設計模式的框架有很多,例如Struts。而前文提到的SpringMVC是另一個更為優(yōu)秀,靈活易用的MVC框架。 SpringMVC是一種基于Java的以請求為驅(qū)動類型的輕量級Web框架,其目的是將Web層進行解耦,即使用“請求-響應”模型,從工程結構上實現(xiàn)良好的分層,區(qū)分職責,簡化Web開發(fā)。
目前,對于如何把這些技術整合起來形成一個完整的解決方案,并沒有相關的最佳實踐。將Spring Boot和Mybatis兩者整合使用的資料和案例較少。因此,本文提供(介紹)一個完整利用SpringBoot和Mybatis來構架Web項目的案例。該案例基于SpringMVC架構提供完整且簡潔的實現(xiàn)Demo,便于開發(fā)人員根據(jù)不同需求和業(yè)務進行拓展。
補充提示,Spring Boot 推薦采用基于 Java 注解的配置方式,而不是傳統(tǒng)的 XML。只需要在主配置 Java 類上添加“@EnableAutoConfiguration”注解就可以啟用自動配置。Spring Boot 的自動配置功能是沒有侵入性的,只是作為一種基本的默認實現(xiàn)。開發(fā)人員可以通過定義其他 bean 來替代自動配置所提供的功能,例如在配置本案例數(shù)據(jù)源(DataSource)時,可以體會到該用法。
二、實踐
一些說明:
項目IDE采用Intellij(主要原因在于Intellij顏值完爆Eclipse,誰叫這是一個看臉的時代)
工程依賴管理采用個人比較熟悉的Maven(事實上SpringBoot與Groovy才是天生一對)
1.預覽:
(1)github地址
https://github.com/djmpink/springboot-mybatis
git : https://github.com/djmpink/springboot-mybatis.git
(2)完整項目結構
(3)數(shù)據(jù)庫
數(shù)據(jù)庫名: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】配置如下:
xmlns:xsi=""
xsi:schemaLocation=" ">
4.0.0
cn.7player.framework
springboot-mybatis
1.0-SNAPSHOT
org.springframework.boot
spring-boot-starter-parent
1.2.5.RELEASE
UTF-8
1.7
org.springframework.boot
spring-boot-starter-web
org.springframework.boot
spring-boot-starter-thymeleaf
org.springframework.boot
spring-boot-starter-jdbc
org.springframework.boot
spring-boot-starter-actuator
org.mybatis
mybatis-spring
1.2.2
org.mybatis
mybatis
3.2.8
org.apache.tomcat
tomcat-jdbc
mysql
mysql-connector-java
com.alibaba
fastjson
1.1.43
com.mangofactory
swagger-springmvc
0.9.5
org.springframework.boot
spring-boot-maven-plugin
spring-milestone
https://repo.spring.io/libs-release
spring-milestone
https://repo.spring.io/libs-release
3.主函數(shù)
【Application.java】包含main函數(shù),像普通java程序啟動即可。
此外,該類中還包含和數(shù)據(jù)庫相關的DataSource,SqlSeesion配置內(nèi)容。
注:@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);
/*
* :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格式數(shù)據(jù),多用于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;
/*
* :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。