前言
作為靠雙手吃飯的廣大程式猿媛們,大家基本都是從資料庫的增删改查一步一步過來的,每天都有寫不完的代碼,好不容易寫完了,又會因為改了需求,為了能完工不得不加班寫這些簡單并且耗時的代碼。
那麼問題來了,我們可不可以去掉這些繁瑣的步驟,把時間更多的放在提升自己的能力上,而不是每天隻是做些簡單重複繁瑣的工作。
推薦
今天撸主給大家推薦一款神器
Spring Data REST
,基于
Spring Data
的
Repository
之上,可以把
Repository
自動輸出為
REST
資源,目前支援
Spring Data JPA、Spring Data MongoDB、Spring Data Neo4j、Spring Data GemFire、Spring Data Cassandra
repository
自動轉換成
REST
服務。
案例
開發環境
- Maven
- JDK1.8
- SpringBoot 2.2.6
- spring-boot-starter-data-jpa
- spring-boot-starter-data-rest
為了測試友善,這裡我們使用
h2
記憶體資料庫
lombok
插件,pom.xml引入:
<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>com.h2database</groupId>
<artifactId>h2</artifactId>
<scope>runtime</scope>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<optional>true</optional>
</dependency>
application.properties
配置檔案:
# 定制根路徑
spring.data.rest.base-path= /api
spring.application.name=restful
# 應用服務web通路端口
server.port=8080
定義使用者實體類:
/**
* 實體類
* https://blog.52itstyle.vip
*/
@Data
@Entity
public class User {
/**
* 使用者id
*/
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
@Column(name = "user_id", nullable = false, length = 20)
private Long userId;
/**
* 使用者名
*/
@Column(name = "username", nullable = false, length = 50)
private String username;
/**
* 密碼
*/
@Column(name = "password", nullable = false, length = 50)
private String password;
/**
* 姓名(昵稱)
*/
@Column(name = "nickname", length = 50)
private String nickname;
/**
* 郵箱
*/
@Column(name = "email", length = 100)
private String email;
/**
* 手機号
*/
@Column(name = "mobile", length = 100)
private String mobile;
}
定義
Repository
,不需要寫一個接口:
@RepositoryRestResource(collectionResourceRel = "user", path = "user")
public interface UserRepository extends JpaRepository<User, Long> {
}
啟動項目,撸主預設初始化了幾個使用者。啟動成功後,通路位址:
http://localhost:8080/api
如果出現以下提示,說明配置成功:
{
"_links" : {
"user" : {
"href" : "http://localhost:8080/api/user{?page,size,sort}",
"templated" : true
},
"profile" : {
"href" : "http://localhost:8080/api/profile"
}
}
}
擷取單個使用者:
http://localhost:8080/api/user/2
分頁查詢:
http://localhost:8080/api/user?page=0&size=10
更多API:
POST請求新增使用者
http://ip:port/api/user
PUT請求更新id為1的使用者
http://ip:port/api/user/1
DELETE請求删除id為1的使用者
http://ip:port/api/user/1
如果以上滿足不了,我們還可以自定義各種查詢:
@RepositoryRestResource(collectionResourceRel = "user", path = "user")
public interface UserRepository extends JpaRepository<User, Long> {
@RestResource(path = "nickname", rel = "nickname")
List<User> findByNickname(@Param("nickname") String nickname);
}
查詢請求:
http://ip:port/api/user/search/nickname?nickname=張三
小結
撸主覺得,這玩意撸一些簡單的項目還是完全可以的,如果是複雜的業務邏輯可能吼不住,還需要自己進行進一步的封裝處理。