Comment on page
入门教程
本文将通过一个简单的demo演示如何使用DoytoQuery框架快速为一个具有如下结构的角色表创建一套RESTful服务。
id | role_name | role_code | valid |
1 | admin | ADMIN | true |
2 | vip | VIP | true |
3 | vip2 | VIP2 | true |
4 | vip3 | VIP3 | true |
5 | guest | GUEST | true |
在阅读本文之前，需要你已经：
- 有Java开发基础
- 掌握一种关系型数据库
- 熟悉Maven
- 熟悉SpringBoot
初始化工程
<dependency>
<groupId>win.doyto</groupId>
<artifactId>doyto-query-jdbc</artifactId>
<version>0.3.0</version>
</dependency>
<dependency>
<groupId>win.doyto</groupId>
<artifactId>doyto-query-web</artifactId>
<version>0.3.0</version>
</dependency>
<dependency>
<groupId>win.doyto</groupId>
<artifactId>doyto-query-dialect</artifactId>
<version>0.0.1-RELEASE</version>
</dependency>
DemoApplication需 要继承
win.doyto.query.web.WebMvcConfigurerAdapterDemoApplication.java
package win.doyto.query.demo;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import win.doyto.query.web.WebMvcConfigurerAdapter;
@SpringBootApplication
public class DemoApplication extends WebMvcConfigurerAdapter {
public static void main(String[] args) {
SpringApplication.run(DoytoQueryDemoApplication.class, args);
}
}
DoytoQuery默认提供的是MySQL的分页插件，而本demo使用的数据库是HSQLDB，所以我们这里需要引入doyto-query-dialect，然后在spring的yaml文件里配置使用。因为这里列名是小写加下划线的格式，这里同时配置一下map-camel-case-to-underscore为true，表示将驼峰形式的字段名映射为下划线形 式的列名：
application.yml
doyto:
query:
config:
dialect: win.doyto.query.dialect.HSQLDBDialect
map-camel-case-to-underscore: true
schema.sql
SET DATABASE SQL SYNTAX MYS TRUE;
drop table t_role if exists;
create table t_role
(
id bigint generated by default as identity (start with 1) primary key,
role_name VARCHAR(100) not null,
role_code VARCHAR(100) not null,
valid boolean DEFAULT TRUE
);
INSERT INTO t_role (role_name, role_code) VALUES ('admin', 'ADMIN');
INSERT INTO t_role (role_name, role_code) VALUES ('vip', 'VIP');
INSERT INTO t_role (role_name, role_code) VALUES ('vip2', 'VIP2');
INSERT INTO t_role (role_name, role_code) VALUES ('vip3', 'VIP3');
INSERT INTO t_role (role_name, role_code) VALUES ('guest', 'GUEST');
- Role实体类，用于映射表字段
RoleEntity.java
package win.doyto.query.demo.module.role;
import lombok.Getter;
import lombok.Setter;
import win.doyto.query.entity.AbstractPersistable;
import win.doyto.query.validation.CreateGroup;
import javax.persistence.Table;
import javax.validation.constraints.NotNull;
@Getter
@Setter
@Table(name = "t_role")
public class RoleEntity extends AbstractPersistable<Integer> {
@NotNull(groups = CreateGroup.class)
private String roleName;
@NotNull(groups = CreateGroup.class)
private String roleCode;
private Boolean valid;
}
- Role查询类，用于生成查询语句
RoleQuery.java
package win.doyto.query.demo.module.role;
import lombok.AllArgsConstructor;
import lombok.Getter;
import lombok.NoArgsConstructor;
import lombok.Setter;
import lombok.experimental.SuperBuilder;
import win.doyto.query.core.PageQuery;
@Getter
@Setter
@NoArgsConstructor
@AllArgsConstructor
@SuperBuilder
public class RoleQuery extends PageQuery {
private String roleNameLike;
}
- Role业务类，用于提供CRUD功能和RESTful接口
RoleController.java
package win.doyto.query.demo.module.role;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import win.doyto.query.web.controller.AbstractEIQController;
@RestController
@RequestMapping("role")
public class RoleController extends AbstractEIQController<RoleEntity, Integer, RoleQuery> {
}
只需以上三个类就完成了整个RESTful服务的开发，接下来我们一起验证一下效果。
将org.springframework.web.servlet.mvc.method.annotation包的日志等级设置为trace，启动DemoApplication，可以看到/role/路径下已经有GET, PUT, PATCH等方法了：
s.w.s.m.m.a.RequestMappingHandlerMapping :
w.d.q.d.m.r.RoleController:
{POST [/role]}: add(List)
{PUT [/role/{id}]}: update(Serializable,Object)
{GET [/role]}: paging(PageQuery)
{GET [/role/{id}]}: getById(Serializable)
{DELETE [/role/{id}]}: deleteById(Serializable)
{PATCH [/role/{id}]}: patch(Serializable,Object)
然后通过curl访问一下分页查询接口：
curl 'http://localhost:8080/role/?roleNameLike=vip&pageNumber=1&pageSize=2&sort=id,desc'
{
"code": 0,
"message": "ok",
"data": {
"list": [
{
"id": 2,
"roleName": "vip",
"roleCode": "VIP",
"valid": true
}
],
"total": 3
},
"success": true
}
可以看到我们使用roleNameLike=vip过滤出3条数据[id=2,3,4]，再根据id倒序排列并通过pageNumber=1和pageSize=2查询出了第二页id为2的记录。
再通过单元测试来验证一下：
@Test
@Rollback
void patchRole() throws Exception {
RequestBuilder requestBuilder = patch("/role/2")
.content("{\"roleName\":\"new role\"}")
.contentType(MediaType.APPLICATION_JSON);
performAndExpectSuccess(requestBuilder);
performAndExpectSuccess(get("/role/2"))
.andExpect(jsonPath("$.data.roleName").value("new role"))
;
}
在这篇教程中，我们只编写了三个业务类就完成了t_role表RESTful服务的开发。其中RoleEntity对象作为数据的载体负责对表数据进行存取，RoleQuery对象作为查询参数的载体负责对查询的数据进行过滤，而RoleController负责提供web接口用于表的访问。另外，通过在RoleQuery类里定义一个字段roleNameLike就完成了对roleName的模糊查询，是不是很神奇？
这只是DoytoQuery功能的冰山一角，更多用法请继续查看后续章节！