基于Java的REST服务框架resty介绍

jieforest · 发表于 2015-1-12 13:09

resty 一款极简的restful轻量级的web框架

拥有jfinal/activejdbc一样的activerecord的简洁设计，使用更简单的restful框架

restful的api设计，是作为restful的服务端最佳选择（使用场景：客户端和服务端解藕，用于对静态的html客户端（mvvm等），ios，andriod等提供服务端的api接口）

一、独有优点：

1.极简的route设计:

@GET("/users/:name") 在路径中自定义解析的参数如果有其他符合也可以用 /users/{name}
// 参数名就是方法变量名除路径参数之外的参数也可以放在方法参数里传递方式 user={json字符串}
public Map find(String name,User user) {
// return Lister.of(name);
return Maper.of("k1", "v1,name:" + name, "k2", "v2");//返回什么数据直接return，完全融入普通方法的方式
}

复制代码

jieforest · 发表于 2015-1-12 13:09

2.极简的activerecord设计，数据操作只需短短的一行,支持批量保存对象

//批量保存
User u1 = new User().set("username", "test").set("providername", "test").set("password", "123456");
User u2 = new User().set("username", "test").set("providername", "test").set("password", "123456");
User.dao.save(u1,u2);
//普通保存
User u = new User().set("username", "test").set("providername", "test").set("password", "123456");
u.save();
//更新
u.update();
//条件更新
User.dao.updateBy(where,paras);
User.dao.updateAll(columns，where,paras);
//删除
u.deleted();
//条件删除
User.dao.deleteBy(where,paras);
User.dao.deleteAll();
//查询
User.dao.findById(id);
User.dao.findBy(where,paras);
User.dao.findAll();
//分页
User.dao.paginateBy(pageNumber,pageSize,where,paras);
User.dao.paginateAll(pageNumber,pageSize);

复制代码

jieforest · 发表于 2015-1-12 13:10

3.极简的客户端设计，支持各种请求，文件上传和文件下载（支持断点续传）

Client client=null;//创建客户端对象
//启动resty-example项目，即可测试客户端
String apiUrl = "http://localhost:8081/api/v1.0";
//如果不需要使用账号登陆
//client = new Client(apiUrl);
//如果有账号权限限制需要登陆
client = new Client(apiUrl, "/tests/login", "u", "123");
//该请求必须登陆之后才能访问未登录时返回 401 未认证
ClientRequest authRequest = new ClientRequest("/users", HttpMethod.GET);
ResponseData authResult = client.build(authRequest).ask();
System.out.println(authResult.getData());
//get
ClientRequest getRequest = new ClientRequest("/tests", HttpMethod.GET);
ResponseData getResult = client.build(getRequest).ask();
System.out.println(getResult.getData());
//post
ClientRequest postRequest = new ClientRequest("/tests", HttpMethod.POST);
postRequest.addParameter("test", Jsoner.toJSONString(Maper.of("a", "谔谔")));
ResponseData postResult = client.build(postRequest).ask();
System.out.println(postResult.getData());
//put
ClientRequest putRequest = new ClientRequest("/tests/x", HttpMethod.PUT);
ResponseData putResult = client.build(putRequest).ask();
System.out.println(putResult.getData());
//delete
ClientRequest deleteRequest = new ClientRequest("/tests/a", HttpMethod.DELETE);
ResponseData deleteResult = client.build(deleteRequest).ask();
System.out.println(deleteResult.getData());
//upload
ClientRequest uploadRequest = new ClientRequest("/tests/resty", HttpMethod.POST);
uploadRequest.addUploadFiles("resty", ClientTest.class.getResource("/resty.jar").getFile());
uploadRequest.addParameter("des", "test file paras 测试笔");
ResponseData uploadResult = client.build(uploadRequest).ask();
System.out.println(uploadResult.getData());
//download 支持断点续传
ClientRequest downloadRequest = new ClientRequest("/tests/file", HttpMethod.GET);
downloadRequest.setDownloadFile(ClientTest.class.getResource("/resty.jar").getFile().replace(".jar", "x.jar"));
ResponseData downloadResult = client.build(downloadRequest).ask();
System.out.println(downloadResult.getData());

复制代码

jieforest · 发表于 2015-1-12 13:10

4.支持多数据源和嵌套事务（使用场景：需要访问多个数据库的应用，或者作为公司内部的数据中间件向客户端提供数据访问api等）

// 在resource里使用事务,也就是controller里，rest的世界认为所以的请求都表示资源，所以这儿叫resource
@GET("/users")
@Transaction(name = {DS.DEFAULT_DS_NAME, "demo"}) //多数据源的事务，如果你只有一个数据库直接@Transaction 不需要参数
public User transaction() {
//TODO 用model执行数据库的操作只要有操作抛出异常两个数据源都会回滚虽然不是分布式事务也能保证代码块的数据执行安全
}
// 如果你需要在service里实现事务，通过java动态代理（必须使用接口，jdk设计就是这样）
public interface UserService {
@Transaction(name = {DS.DEFAULT_DS_NAME, "demo"})//service里添加多数据源的事务，如果你只有一个数据库直接@Transaction 不需要参数
public User save(User u);
}
// 在resource里使用service层的事务
// @Transaction(name = {DS.DEFAULT_DS_NAME, "demo"})的注解需要写在service的接口上
// 注意java的自动代理必须存在接口
// TransactionAspect 是事务切面，你也可以实现自己的切面比如日志的Aspect，实现Aspect接口
// 再private UserService userService = AspectFactory.newInstance(new UserServiceImpl(), new TransactionAspect(),new LogAspect());
private UserService userService = AspectFactory.newInstance(new UserServiceImpl(), new TransactionAspect());

复制代码

jieforest · 发表于 2015-1-12 13:10

5.极简的权限设计，你只需要实现一个简单接口和添加一个拦截器，即可实现基于url的权限设计

public void configInterceptor(InterceptorLoader interceptorLoader) {
//权限拦截器放在第一位第一时间判断避免执行不必要的代码
interceptorLoader.add(new SecurityInterceptor(new MyAuthenticateService()));
}
//实现接口
public class MyAuthenticateService implements AuthenticateService {
//登陆时通过name获取用户的密码和权限信息
public Principal findByName(String name) {
DefaultPasswordService defaultPasswordService = new DefaultPasswordService();
Principal principal = new Principal(name, defaultPasswordService.hash("123"), new HashSet<String>() {{
add("api");
}});
return principal;
}
//基础的权限总表所以的url权限都放在这儿你可以通过文件或者数据库或者直接代码来设置所有权限
public Set<Permission> loadAllPermissions() {
Set<Permission> permissions = new HashSet<Permission>();
permissions.add(new Permission("GET", "/api/transactions**", "api"));
return permissions;
}
}

复制代码

zhang_lixin · 发表于 2018-8-8 17:16

（1）通过配置应用程序调用rest服务年编写java类型的应用程序，在java程序中调用rest服务（2）以web服务的形式调用rest服务此种方式对rest服务的声明有一定要求，声明方式如下所示，仅供参考： @Mapping("/rest/getUserInfo"

public Renderer cnkeet() throws Exception { ActionContext ac=ActionContext.getActionContext(); HttpServletRequesthrq=ac.getHttpServletRequest();Stringid=hrq.getParameter(“id”); JSONObject object=new JSONObject(); object.put(“id”, id); return new PlainRenderer(object.toString()); } 此种声明方式需要通过request获取参数值】注：如果rest服务声明为如下形式 @Mapping("/rest/getUserInfo/$1/$2"

public Renderer getUserInfo(String id) throws Exception { } 工作流在调用rest服务时，url为http://ip

ort/context/rest/getUserInfo?t=""&n="" 。与rest声明不符，调用失败，导致调用rest服务失败。具体可参考东软官网，https://platform.neusoft.com/