前言
作为靠双手吃饭的广大程序猿媛们,大家基本都是从数据库的增删改查一步一步过来的,每天都有写不完的代码,好不容易写完了,又会因为改了需求,为了能完工不得不加班写这些简单并且耗时的代码。
那么问题来了,我们可不可以去掉这些繁琐的步骤,把时间更多的放在提升自己的能力上,而不是每天只是做些简单重复繁琐的工作。
推荐
今天撸主给大家推荐一款神器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=张三
小结
撸主觉得,这玩意撸一些简单的项目还是完全可以的,如果是复杂的业务逻辑可能吼不住,还需要自己进行进一步的封装处理。