Spring Data Rest！幾分鐘幫我們實(shí)現(xiàn)Rest服務(wù)
一弥激、概述
一直認(rèn)為进陡，Spring Data是與第三方組件進(jìn)行數(shù)據(jù)交換的全家桶的整合，比如Spring Data Jpa是數(shù)據(jù)庫(kù)使用微服，Spring Data LDAP是LDAP的使用四濒，Spring Data Redis是Redis的使用，Spring Data Elasticsearch是Elasticsearch的使用职辨。
然而，不起眼的地方有一個(gè)Spring Data Rest戈二，按照常規(guī)定義舒裤，它是與Rest組件的數(shù)據(jù)交互？
非也觉吭，Spring Data Rest只是一種快速提供rest服務(wù)的方式腾供，通過(guò)與Spring Data xxx整合，快速實(shí)現(xiàn)CRUD鲜滩，自動(dòng)將repository 自動(dòng)輸出為REST資源伴鳖，目前支持Spring Data JPA、Spring Data MongoDB徙硅、Spring Data Neo4j榜聂、Spring Data GemFire、Spring Data Cassandra的 repository 自動(dòng)轉(zhuǎn)換成REST服務(wù)嗓蘑。
Spring Data REST把我們需要編寫的大量REST模版接口做了自動(dòng)化實(shí)現(xiàn)须肆。
所以匿乃，五分鐘實(shí)現(xiàn)rest服務(wù)不是夢(mèng)，比我寫文章都快豌汇！
首發(fā)地址：
品茗IT-同步發(fā)布
如果大家正在尋找一個(gè)java的學(xué)習(xí)環(huán)境幢炸，或者在開發(fā)中遇到困難，可以加入我們的java學(xué)習(xí)圈拒贱，點(diǎn)擊即可加入宛徊，共同學(xué)習(xí)，節(jié)約學(xué)習(xí)時(shí)間逻澳，減少很多在學(xué)習(xí)中遇到的難題闸天。
二、配置
本文以Spring Data JPA結(jié)合Spring Data Rest為例赡盘，描述如何使用Spring Data Rest号枕。
2.1 依賴
引入spring-boot-starter-data-rest和spring-boot-starter-data-jpa，使用Spring Data JPA陨享，就必須引入mysql-connector-java和數(shù)據(jù)源葱淳。
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-jpa</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-rest</artifactId>
</dependency>
<dependency>
<groupId>org.apache.commons</groupId>
<artifactId>commons-dbcp2</artifactId>
</dependency>
<dependency>
<groupId>mysql</groupId>
<artifactId>mysql-connector-java</artifactId>
</dependency>
2.2 配置文件
配置文件中只需要配置數(shù)據(jù)源和jpa相關(guān)信息即可，如：
server.port=8040
spring.datasource.driverClassName = com.mysql.jdbc.Driver
spring.datasource.url=jdbc:mysql://127.0.0.1:3306/boot?useUnicode=true&characterEncoding=utf8&serverTimezone=UTC
spring.datasource.username=cff
spring.datasource.password=123456
spring.datasource.type=org.apache.commons.dbcp2.BasicDataSource
spring.datasource.dbcp2.max-wait-millis=60000
spring.datasource.dbcp2.min-idle=20
spring.datasource.dbcp2.initial-size=2
spring.datasource.dbcp2.validation-query=SELECT 1
spring.datasource.dbcp2.connection-properties=characterEncoding=utf8
spring.datasource.dbcp2.validation-query=SELECT 1
spring.datasource.dbcp2.test-while-idle=true
spring.datasource.dbcp2.test-on-borrow=true
spring.datasource.dbcp2.test-on-return=false
spring.jpa.database=MySQL
spring.jpa.show-sql=true
spring.jpa.hibernate.ddl-auto=none
spring.jpa.hibernate.naming.implicit-strategy=org.springframework.boot.orm.jpa.hibernate.SpringImplicitNamingStrategy
spring.jpa.hibernate.naming.physical-strategy=org.springframework.boot.orm.jpa.hibernate.SpringPhysicalNamingStrategy
三抛姑、配置Rest訪問(wèn)
需要在實(shí)體上加上Spring data jpa 需要的注解：
import javax.persistence.Column;
import javax.persistence.Entity;
import javax.persistence.Id;
import javax.persistence.Table;
import com.fasterxml.jackson.annotation.JsonIgnore;
@Entity
@Table(name = "user_info")
public class UserInfo {
@Id
@Column(name = "user_name")
private String userName;
@JsonIgnore
private String passwd;
private String name;
private String mobile;
private String valid;
@Column(name = "user_type")
private String userType;
public void setUserName(String userName) {
this.userName = userName;
}
public String getUserName() {
return userName;
}
public void setPasswd(String passwd) {
this.passwd = passwd;
}
public String getPasswd() {
return passwd;
}
public void setName(String name) {
this.name = name;
}
public String getName() {
return name;
}
public void setMobile(String mobile) {
this.mobile = mobile;
}
public String getMobile() {
return mobile;
}
public void setValid(String valid) {
this.valid = valid;
}
public String getValid() {
return valid;
}
public void setUserType(String userType) {
this.userType = userType;
}
public String getUserType() {
return userType;
}
}
對(duì)于不想暴漏的字段赞厕，使用@JsonIgnore即可。
同時(shí)定硝，在自定義的Repository中加入@RepositoryRestResource注解：
import java.util.List;
import org.springframework.data.jpa.repository.JpaRepository;
import org.springframework.data.repository.query.Param;
import org.springframework.data.rest.core.annotation.RepositoryRestResource;
import org.springframework.data.rest.core.annotation.RestResource;
import com.cff.springbootwork.domain.UserInfo;
/**
* collectionResourceRel是json的最外層顯示名稱皿桑，path是訪問(wèn)路徑
*
* @author fufei
*
*/
@RepositoryRestResource(collectionResourceRel = "user", path = "user")
public interface UserInfoDao extends JpaRepository<UserInfo, String> {
List<UserInfo> findByName(@Param("name") String name);
/**
* 不暴漏刪除接口
*/
@Override
@RestResource(exported = false)
void deleteById(String id);
@Override
@RestResource(exported = false)
void delete(UserInfo entity);
}
對(duì)于不需要暴漏的接口，可以使用@RestResource(exported = false)隱藏該接口蔬啡。
Spring Data Rest并不妨礙你傳統(tǒng)的寫法诲侮，你仍可以定義自己的controller、service和dao等箱蟆！
四沟绪、使用方法
Springboot啟動(dòng)項(xiàng)目以后，我們就可以直接使用rest服務(wù)了空猜。
4.1 查詢
查詢所有用戶绽慈，使用get請(qǐng)求發(fā)送http://127.0.0.1:8040/user：
{
"_embedded" : {
"user" : [ {
"name" : null,
"mobile" : "4444",
"valid" : "0",
"userType" : "1",
"_links" : {
"self" : {
"href" : "http://127.0.0.1:8040/user/15607110725"
},
"userInfo" : {
"href" : "http://127.0.0.1:8040/user/15607110725"
}
}
}, {
"name" : null,
"mobile" : "3242",
"valid" : null,
"userType" : "2",
"_links" : {
"self" : {
"href" : "http://127.0.0.1:8040/user/3453sdf"
},
"userInfo" : {
"href" : "http://127.0.0.1:8040/user/3453sdf"
}
}
} ]
},
"_links" : {
"self" : {
"href" : "http://127.0.0.1:8040/user{?page,size,sort}",
"templated" : true
},
"profile" : {
"href" : "http://127.0.0.1:8040/profile/user"
},
"search" : {
"href" : "http://127.0.0.1:8040/user/search"
}
},
"page" : {
"size" : 20,
"totalElements" : 2,
"totalPages" : 1,
"number" : 0
}
}
上面 _links 節(jié)點(diǎn)下的內(nèi)容提示我們
- 可以使用
http://127.0.0.1:8040/user{?page,size,sort}進(jìn)行分頁(yè)查詢。 - 使用
http://127.0.0.1:8040/profile/user查看user實(shí)體相關(guān)辈毯。 - 使用
http://127.0.0.1:8040/user/search進(jìn)行search查詢（自定義的查詢接口）坝疼； - 每條記錄都有提示如何根據(jù)主鍵進(jìn)行查詢的方法。
輸入http://127.0.0.1:8040/user/15607110725谆沃，就能查出15607110725這條記錄：
{
"name" : "cff",
"mobile" : "4444",
"valid" : "0",
"userType" : "1",
"_links" : {
"self" : {
"href" : "http://127.0.0.1:8040/user/15607110725"
},
"userInfo" : {
"href" : "http://127.0.0.1:8040/user/15607110725"
}
}
}
輸入http://127.0.0.1:8040/user?page=0&size=10&sort=mobile,desc钝凶，可以進(jìn)行分頁(yè)排序查詢,這里的排序字段sort是根據(jù)mobile字段desc排序的：
{
"_embedded" : {
"user" : [ {
"name" : "cff",
"mobile" : "4444",
"valid" : "0",
"userType" : "1",
"_links" : {
"self" : {
"href" : "http://127.0.0.1:8040/user/15607110725"
},
"userInfo" : {
"href" : "http://127.0.0.1:8040/user/15607110725"
}
}
}, {
"name" : null,
"mobile" : "3242",
"valid" : "0",
"userType" : "1",
"_links" : {
"self" : {
"href" : "http://127.0.0.1:8040/user/3453sdf"
},
"userInfo" : {
"href" : "http://127.0.0.1:8040/user/3453sdf"
}
}
} ]
},
"_links" : {
"self" : {
"href" : "http://127.0.0.1:8040/user"
},
"profile" : {
"href" : "http://127.0.0.1:8040/profile/user"
},
"search" : {
"href" : "http://127.0.0.1:8040/user/search"
}
},
"page" : {
"size" : 10,
"totalElements" : 2,
"totalPages" : 1,
"number" : 0
}
}
輸入http://127.0.0.1:8040/user/search，可以顯示當(dāng)前可以用來(lái)search的接口列表：
{
"_links" : {
"findByName" : {
"href" : "http://127.0.0.1:8040/user/search/findByName{?name}",
"templated" : true
},
"self" : {
"href" : "http://127.0.0.1:8040/user/search"
}
}
}
表示唁影，可以用http://127.0.0.1:8040/user/search/findByName{?name}來(lái)進(jìn)行search操作腿椎。
輸入http://127.0.0.1:8040/user/search/findByName?name=cff：
{
"_embedded" : {
"user" : [ {
"name" : "cff",
"mobile" : "4444",
"valid" : "0",
"userType" : "1",
"_links" : {
"self" : {
"href" : "http://127.0.0.1:8040/user/15607110725"
},
"userInfo" : {
"href" : "http://127.0.0.1:8040/user/15607110725"
}
}
} ]
},
"_links" : {
"self" : {
"href" : "http://127.0.0.1:8040/user/search/findByName?name=cff"
}
}
}
4.2 保存
使用POST方式訪問(wèn) http://localhost:8040/user并提交如下的JSON 數(shù)據(jù)：
{
"userName":"test",
"passwd":"123123",
"mobile":"21312312",
"name":"heihei"
}
這里桌硫，因?yàn)樯厦鎸?shí)體userInfo的passwd字段加了@JsonIgnore注解，提交的json中啃炸，passwd是無(wú)效的铆隘。
官方文檔中說(shuō)可以把@RestResource(exported = false)加到字段上，經(jīng)試驗(yàn)無(wú)效南用，所以遇到這種情況還是手寫controller吧膀钠。
4.3 更新
跟保存方式一樣，已經(jīng)存在的字段裹虫，如果這次不填肿嘲，就被更新為null了。
4.4 刪除
使用DELETE方式請(qǐng)求 http://localhost:8040/user/test：
會(huì)提示405 Method Not Allowed筑公，這是因?yàn)槲覀冊(cè)赿elete方法上加了@RestResource(exported = false)注解雳窟，去掉該注解即可，注意是delete方法匣屡，deleteById方法加不加都無(wú)所謂封救。
重新請(qǐng)求，成功刪除捣作。
五誉结、總結(jié)
Spring Data Rest 官網(wǎng) 很詳細(xì)的說(shuō)明了如何使用Spring Data Rest，盡管Spring Data Rest有很大的局限性券躁，但5分鐘搞定一個(gè)Rest服務(wù)真的很贊惩坑，而且不影響傳統(tǒng)寫法，很適合快速開發(fā)也拜。
快速構(gòu)建項(xiàng)目
Spring項(xiàng)目快速開發(fā)工具：
一鍵快速構(gòu)建SpringBoot項(xiàng)目工具
一鍵快速構(gòu)建SpringCloud項(xiàng)目工具
喜歡這篇文章么以舒，喜歡就加入我們一起討論SpringBoot使用吧！
