在去年的時候,在各種渠道中略微的了解了springboot,在開發(fā)web項目的時候是如何的方便、快捷。但是當時并沒有認真的去學習下,畢竟感覺自己在struts和springmvc都用得不太熟練。不過在看了很多關于springboot的介紹之后,并沒有想象中的那么難,于是開始準備學習springboot。 在閑暇之余的時候,看了下springboot實戰(zhàn)以及一些大神關于springboot的博客之后,開始寫起了我的第一個springboot的項目。在能夠對springboot進行一些簡單的開發(fā)restful風格接口實現crud功能之后,于是便有了本篇博文。
springboot介紹
spring boot是由pivotal團隊提供的全新框架,其設計目的是用來簡化新spring應用的初始搭建以及開發(fā)過程。該框架使用了特定的方式來進行配置,從而使開發(fā)人員不再需要定義樣板化的配置。
簡單的來說就是,只需幾個jar和一些簡單的配置,就可以快速開發(fā)項目。
假如我就想簡單的開發(fā)一個對外的接口,那么只需要以下代碼就可以了。
一個主程序啟動springboot
1
2
3
4
5
6
|
@springbootapplication public class application { public static void main(string[] args) { springapplication.run(application. class , args); } } |
控制層
1
2
3
4
5
6
7
|
@restcontroller public class helloworldcontroller { @requestmapping ( "/hello" ) public string index() { return "hello world" ; } } |
成功啟動主程序之后,編寫控制層,然后在瀏覽器輸入 http://localhost:8080//hello 便可以查看信息。
感覺使用springboot開發(fā)程序是不是非常的簡單呢!
用springboot實戰(zhàn)的話來說:
這里沒有配置,沒有web.xml,沒有構建說明,甚至沒有應用服務器,但這就是整個應用程序了。springboot會搞定執(zhí)行應用程序所需的各種后勤工作,你只要搞定應用程序的代碼就好。
基于springboot開發(fā)一個restful服務
在開發(fā)程序之前,應先做好一下準備
一、開發(fā)準備
1.1 數據庫和表
1
2
3
4
5
6
7
8
9
|
create database `springboot`; use `springboot`; drop table if exists `t_user`; create table `t_user` ( `id` int ( 11 ) not null auto_increment comment 'id' , `name` varchar( 10 ) default null comment '姓名' , `age` int ( 2 ) default null comment '年齡' , primary key (`id`) ) engine=innodb auto_increment= 12 default charset=utf8; |
1.2 maven相關依賴
springboot最核心的jar
spring-boot-starter :核心模塊,包括自動配置支持、日志和yaml;
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
|
<parent> <groupid>org.springframework.boot</groupid> <artifactid>spring-boot-starter-parent</artifactid> <version> 1.5 . 9 .release</version> <relativepath/> </parent> <properties> <project.build.sourceencoding>utf- 8 </project.build.sourceencoding> <java.version> 1.7 </java.version> <mybatis-spring-boot> 1.2 . 0 </mybatis-spring-boot> <mysql-connector> 5.1 . 39 </mysql-connector> </properties> <dependencies> <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> <dependency> <groupid>org.springframework.boot</groupid> <artifactid>spring-boot-starter-data-jpa</artifactid> </dependency> <dependency> <groupid>org.springframework.boot</groupid> <artifactid>spring-boot-devtools</artifactid> <optional> true </optional> </dependency> <dependency> <groupid>org.springframework.boot</groupid> <artifactid>spring-boot-starter-test</artifactid> <scope>test</scope> </dependency> <!-- spring boot mybatis 依賴 --> <dependency> <groupid>org.mybatis.spring.boot</groupid> <artifactid>mybatis-spring-boot-starter</artifactid> <version>${mybatis-spring-boot}</version> </dependency> <!-- mysql 連接驅動依賴 --> <dependency> <groupid>mysql</groupid> <artifactid>mysql-connector-java</artifactid> <version>${mysql-connector}</version> </dependency> </dependencies> <build> <plugins> <!--運用springboot 插件 使用spring-boot-devtools模塊的應用,當classpath中的文件有改變時,會自動重啟! --> <plugin> <groupid>org.springframework.boot</groupid> <artifactid>spring-boot-maven-plugin</artifactid> <configuration> <fork> true </fork> </configuration> </plugin> </plugins> </build> |
二、工程說明
2.1工程結構圖:
com.pancm.web - controller 層
com.pancm.dao - 數據操作層 dao
com.pancm.bean - 實體類
com.pancm.bean.service - 業(yè)務邏輯層
application - 應用啟動類
application.properties - 應用配置文件,應用啟動會自動讀取配置
2.2 自定義配置文件
一般我們需要一些自定義的配置,例如配置jdbc的連接配置,在這里我們可以用 application.properties 進行配置。數據源實際的配置以各位的為準。
1
2
3
4
5
6
7
8
9
10
|
## 數據源配置 spring.datasource.url=jdbc:mysql: //localhost:3306/springboot?useunicode=true&characterencoding=utf8 spring.datasource.username=root spring.datasource.password= 123456 spring.datasource.driver- class -name=com.mysql.jdbc.driver ## mybatis 配置 # 配置為 com.pancm.bean 指向實體類包路徑。 mybatis.typealiasespackage=com.pancm.bean # 配置為 classpath 路徑下 mapper 包下,* 代表會掃描所有 xml 文件。 mybatis.mapperlocations=classpath\:mapper/*.xml |
三、代碼編寫
3.1 pojo類user的編寫
來到重點的代碼這快了。
我們開始先編寫pojo類,對應數據庫中的t_user表。
代碼如下
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
|
public class user { /** 編號 */ private int id; /** 姓名 */ private string name; /** 年齡 */ private int age; public user(){ } public class user { /** 編號 */ private int id; /** 姓名 */ private string name; /** 年齡 */ private int age; public user(){ } // getter和 setter 略 } |
3.2 dao層編寫
在以前的dao層這塊,hibernate和mybatis 都可以使用注解或者使用mapper配置文件。在這里我們使用spring的jpa來完成crud。
說明:
一般有兩種方式實現與數據庫實現crud:
第一種是xml的mapper配置。
第二種是使用注解,@insert、@select、@update、@delete 這些來完成。本篇使用的是第二種
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
|
import org.apache.ibatis.annotations.delete; import org.apache.ibatis.annotations.insert; import org.apache.ibatis.annotations.mapper; import org.apache.ibatis.annotations.result; import org.apache.ibatis.annotations.results; import org.apache.ibatis.annotations.select; import org.apache.ibatis.annotations.update; import org.springframework.data.repository.query.param; import com.pancm.bean.user; @mapper public interface userdao { /** * 用戶數據新增 */ @insert ( "insert into t_user(id,name,age) values (#{id},#{name},#{age})" ) void adduser(user user); /** * 用戶數據修改 */ @update ( "update t_user set name=#{name},age=#{age} where id=#{id}" ) void updateuser(user user); /** * 用戶數據刪除 */ @delete ( "delete from t_user where id=#{id}" ) void deleteuser( int id); /** * 根據用戶名稱查詢用戶信息 * */ @select ( "select id,name,age from t_user" ) // 返回 map 結果集 @results ({ @result (property = "id" , column = "id" ), @result (property = "name" , column = "name" ), @result (property = "age" , column = "age" ), }) user findbyname( @param ( "name" ) string username); /** * 根據用戶id查詢用戶信息 * */ @select ( "select id,name,age from t_user" ) user findbyid( @param ( "id" ) int userid); /** * 根據用戶age查詢用戶信息 */ @select ( "select id,name,age from t_user where age = #{userage}" ) user findbyage( int userage); } |
這個接口使用的注解個人理解:
mapper : 在接口上添加了這個注解表示這個接口是基于注解實現的crud。
results: 返回的map結果集,property 表示user類的字段,column 表示對應數據庫的字段。
param:sql條件的字段。
insert、select、update、delete:對應數據庫的增、查、改、刪。
3.3 service 業(yè)務邏輯層
這塊和hibernate、mybatis的基本一樣。
代碼如下:
接口
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
|
import com.pancm.bean.user; /** * * title: userservice * description:用戶接口 * version:1.0.0 * @author pancm * @date 2018年1月9日 */ public interface userservice { /** * 新增用戶 * @param user * @return */ boolean adduser(user user); /** * 修改用戶 * @param user * @return */ boolean updateuser(user user); /** * 刪除用戶 * @param id * @return */ boolean deleteuser( int id); /** * 根據用戶名字查詢用戶信息 * @param username */ user finduserbyname(string username); /** * 根據用戶id查詢用戶信息 * @param userid */ user finduserbyid( int userid); /** * 根據用戶id查詢用戶信息 * @param userage */ user finduserbyage( int userage); } |
實現類
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
|
import org.springframework.beans.factory.annotation.autowired; import org.springframework.stereotype.service; import com.pancm.bean.user; import com.pancm.dao.userdao; import com.pancm.service.userservice; /** * * title: userserviceimpl * description: * 用戶操作實現類 * version:1.0.0 * @author pancm * @date 2018年1月9日 */ @service public class userserviceimpl implements userservice { @autowired private userdao userdao; @override public boolean adduser(user user) { boolean flag= false ; try { userdao.adduser(user); flag= true ; } catch (exception e){ e.printstacktrace(); } return flag; } @override public boolean updateuser(user user) { boolean flag= false ; try { userdao.updateuser(user); flag= true ; } catch (exception e){ e.printstacktrace(); } return flag; } @override public boolean deleteuser( int id) { boolean flag= false ; try { userdao.deleteuser(id); flag= true ; } catch (exception e){ e.printstacktrace(); } return flag; } @override public user finduserbyname(string username) { return userdao.findbyname(username); } @override public user finduserbyid( int userid) { return userdao.findbyid(userid); } @override public user finduserbyage( int userage) { return userdao.findbyage(userage); } } |
3.4 controller 控制層
控制層這塊和springmvc很像,但是相比而言要簡潔不少。
關于控制層的注解個人的理解如下:
restcontroller:默認類中的方法都會以json的格式返回。
requestmapping: 接口路徑配置。
method : 請求格式。
requestparam: 請求參數。
具體實現如下:
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
|
import org.springframework.beans.factory.annotation.autowired; import org.springframework.web.bind.annotation.requestmapping; import org.springframework.web.bind.annotation.requestmethod; import org.springframework.web.bind.annotation.requestparam; import org.springframework.web.bind.annotation.restcontroller; import com.pancm.bean.user; import com.pancm.service.userservice; /** * * title: userrestcontroller * description: * 用戶數據操作接口 * version:1.0.0 * @author pancm * @date 2018年1月9日 */ @restcontroller @requestmapping (value = "/api/user" ) public class userrestcontroller { @autowired private userservice userservice; @requestmapping (value = "/adduser" , method = requestmethod.post) public boolean adduser( user user) { system.out.println( "開始新增..." ); return userservice.adduser(user); } @requestmapping (value = "/updateuser" , method = requestmethod.put) public boolean updateuser( user user) { system.out.println( "開始更新..." ); return userservice.updateuser(user); } @requestmapping (value = "/deleteuser" , method = requestmethod.delete) public boolean delete( @requestparam (value = "username" , required = true ) int userid) { system.out.println( "開始刪除..." ); return userservice.deleteuser(userid); } @requestmapping (value = "/username" , method = requestmethod.get) public user findbyusername( @requestparam (value = "username" , required = true ) string username) { system.out.println( "開始查詢..." ); return userservice.finduserbyname(username); } @requestmapping (value = "/userid" , method = requestmethod.get) public user findbyuserid( @requestparam (value = "userid" , required = true ) int userid) { system.out.println( "開始查詢..." ); return userservice.finduserbyid(userid); } @requestmapping (value = "/userage" , method = requestmethod.get) public user findbyuserage( @requestparam (value = "userage" , required = true ) int userage) { system.out.println( "開始查詢..." ); return userservice.finduserbyid(userage); } } |
3.5 application 主程序
springapplication 則是用于從main方法啟動spring應用的類。
默認,它會執(zhí)行以下步驟:
1.創(chuàng)建一個合適的applicationcontext實例 (取決于classpath)。
2.注冊一個commandlinepropertysource,以便將命令行參數作為spring properties。
3.刷新application context,加載所有單例beans。
4.激活所有commandlinerunner beans。
直接使用main啟動該類,springboot便自動化配置了。
ps:即使是現在我依舊覺得這個實在是太厲害了。
該類的一些注解說明。:
springbootapplication:開啟組件掃描和自動配置。
mapperscan: mapper 接口類掃描包配置
代碼如下:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
|
import org.mybatis.spring.annotation.mapperscan; import org.springframework.boot.springapplication; import org.springframework.boot.autoconfigure.springbootapplication; /** * * title: application * description: * springboot 主程序 * version:1.0.0 * @author pancm * @date 2018年1月5日 */ @springbootapplication @mapperscan ( "com.pancm.dao" ) public class application { public static void main(string[] args) { // 啟動嵌入式的 tomcat 并初始化 spring 環(huán)境及其各 spring 組件 springapplication.run(application. class , args); system.out.println( "程序正在運行..." ); } } |
四、代碼測試
代碼編寫完之后,我們進行代碼的測試。
啟動application 之后,使用postman工具進行接口的測試。
測試結果如下:
這里只使用了一個get和post測試,實際方法都測試過了,但是感覺沒必要貼圖了。
項目我放到github上面去了: https://github.com/xuwujing/springboot
總結
以上所述是小編給大家介紹的基于springboot開發(fā)一個restful服務實現增刪改查功能,希望對大家有所幫助,如果大家有任何疑問請給我留言,小編會及時回復大家的。在此也非常感謝大家對服務器之家網站的支持!
原文鏈接:http://www.panchengming.com/2018/01/10/pancm67/?utm_source=tuicool&utm_medium=referral