一、熱身
一個現實的場景是:當我們開發一個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地址
https://github.com/djmpink/springboot-mybatis
git : https://github.com/djmpink/springboot-mybatis.git
(2)完整項目結構
(3)數據庫
數據庫名:test
【user.sql】
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
|
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】配置如下:
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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
|
<?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路徑)
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
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
|
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下:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
|
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請求。
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
|
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測試》
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
32
33
34
35
|
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】
1
2
3
4
|
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時的注解
1
|
@configurationproperties (prefix=“spring.datasource”) |
表示將根據前綴“spring.datasource”從application.properties中匹配相關屬性值。
(2)【usermapper.xml】
mybatis的sql映射文件。mybatis同樣支持注解方式,在此不予舉例了。
1
2
3
4
5
6
7
|
<?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
1
2
3
4
5
|
package cn.no7player.mapper; import cn.no7player.model.user; public interface usermapper { public user finduserinfo(); } |
三、總結
(1)運行 application.java
(2)控制臺輸出:
…..(略過無數內容)
(3)訪問:
針對三種控制器的訪問分別為:
視圖:
json:
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》
http://www.javacodegeeks.com/2014/09/using-configurationproperties-in-spring-boot.html?utm_source=tuicool
《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 文件
以上所述是小編給大家介紹的基于springboot與mybatis實現springmvc web項目,希望對大家有所幫助,如果大家有任何疑問請給我留言,小編會及時回復大家的。在此也非常感謝大家對服務器之家網站的支持!
原文鏈接:http://www.cnblogs.com/onetwo/p/6237181.html