极简的Restful框架推荐推荐:Resty(服务端+客户端)

开发 前端
resty一款极简的restful轻量级的web框架,拥有jfinal/activejdbc一样的activerecord的简洁设计,使用更简单的restful框架。

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

restful的api设计,是作为restful的服务端***选择(使用场景:客户端和服务端解藕,用于对静态的html客户端(mvvm等),ios,andriod等提供服务端的api接口)

一、独有优点:

1.极简的route设计:

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

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

 

 

  1. //批量保存  
  2. User u1 = new User().set("username""test").set("providername""test").set("password""123456");  
  3. User u2 = new User().set("username""test").set("providername""test").set("password""123456");  
  4. User.dao.save(u1,u2);  
  5.    
  6. //普通保存  
  7. User u = new User().set("username""test").set("providername""test").set("password""123456");  
  8. u.save();  
  9.    
  10. //更新  
  11. u.update();  
  12. //条件更新  
  13. User.dao.updateBy(where,paras);  
  14. User.dao.updateAll(columns,where,paras);  
  15.    
  16. //删除  
  17. u.deleted();  
  18. //条件删除  
  19. User.dao.deleteBy(where,paras);  
  20. User.dao.deleteAll();  
  21.    
  22. //查询  
  23. User.dao.findById(id);  
  24. User.dao.findBy(where,paras);  
  25. User.dao.findAll();  
  26.    
  27. //分页  
  28. User.dao.paginateBy(pageNumber,pageSize,where,paras);  
  29. User.dao.paginateAll(pageNumber,pageSize); 

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

 

  1. Client client=null;//创建客户端对象  
  2. //启动resty-example项目,即可测试客户端  
  3. String apiUrl = "http://localhost:8081/api/v1.0";  
  4. //如果不需要 使用账号登陆  
  5. //client = new Client(apiUrl);  
  6. //如果有账号权限限制  需要登陆  
  7. client = new Client(apiUrl, "/tests/login""u""123");  
  8.    
  9. //该请求必须  登陆之后才能访问  未登录时返回 401  未认证  
  10. ClientRequest authRequest = new ClientRequest("/users", HttpMethod.GET);  
  11. ResponseData authResult = client.build(authRequest).ask();  
  12. System.out.println(authResult.getData());  
  13.    
  14. //get  
  15. ClientRequest getRequest = new ClientRequest("/tests", HttpMethod.GET);  
  16. ResponseData getResult = client.build(getRequest).ask();  
  17. System.out.println(getResult.getData());  
  18.    
  19. //post  
  20. ClientRequest postRequest = new ClientRequest("/tests", HttpMethod.POST);  
  21. postRequest.addParameter("test", Jsoner.toJSONString(Maper.of("a""谔谔")));  
  22. ResponseData postResult = client.build(postRequest).ask();  
  23. System.out.println(postResult.getData());  
  24.    
  25. //put  
  26. ClientRequest putRequest = new ClientRequest("/tests/x", HttpMethod.PUT);  
  27. ResponseData putResult = client.build(putRequest).ask();  
  28. System.out.println(putResult.getData());  
  29.    
  30.    
  31. //delete  
  32. ClientRequest deleteRequest = new ClientRequest("/tests/a", HttpMethod.DELETE);  
  33. ResponseData deleteResult = client.build(deleteRequest).ask();  
  34. System.out.println(deleteResult.getData());  
  35.    
  36.    
  37. //upload  
  38. ClientRequest uploadRequest = new ClientRequest("/tests/resty", HttpMethod.POST);  
  39. uploadRequest.addUploadFiles("resty", ClientTest.class.getResource("/resty.jar").getFile());  
  40. uploadRequest.addParameter("des""test file  paras  测试笔");  
  41. ResponseData uploadResult = client.build(uploadRequest).ask();  
  42. System.out.println(uploadResult.getData());  
  43.    
  44.    
  45. //download  支持断点续传  
  46. ClientRequest downloadRequest = new ClientRequest("/tests/file", HttpMethod.GET);  
  47. downloadRequest.setDownloadFile(ClientTest.class.getResource("/resty.jar").getFile().replace(".jar""x.jar"));  
  48. ResponseData downloadResult = client.build(downloadRequest).ask();  
  49. System.out.println(downloadResult.getData()); 

4.支持多数据源和嵌套事务(使用场景:需要访问多个数据库的应用,或者作为公司内部的数据中间件向客户端提供数据访问api等)5.极简的权限设计,你只需要实现一个简单接口和添加一个拦截器,即可实现基于url的权限设计

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

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

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

6.极简的缓存设计,可扩展,非常简单即可启用model的自动缓存功能7.下载文件,只需要直接return file

  1. public void configConstant(ConstantLoader constantLoader) {  
  2.   //启用缓存并在要自动使用缓存的model上  开启缓存@Table(name = "sec_user", cached = true)  
  3.   constantLoader.setCacheEnable(true);  
  4. }  
  5.    
  6. @Table(name = "sec_user", cached = true)  
  7. public class User extends Model<User> {  
  8.   public static User dao = new User();  
  9.    

 

7.下载文件,只需要直接return file

  1. @GET("/files")  
  2. public File file() {  
  3.   return new File(path);  

8.上传文件,通过getFiles,getFile把文件写到服务器

  1. @POST("/files")  
  2. public UploadedFile file() {  
  3.   //Hashtable<String, UploadedFile> uploadedFiles=getFiles();  
  4.   return getFile(name);  

9.当然也是支持传统的web开发,你可以自己实现数据解析,在config里添加自定义的解析模板

  1. public void configConstant(ConstantLoader constantLoader) {  
  2.   // 通过后缀来返回不同的数据类型  你可以自定义自己的  render  如:FreemarkerRender  
  3.   // constantLoader.addRender("json", new JsonRender());  
  4.   //默认已添加json和text的支持,只需要把自定义的Render add即可  

二、运行example示例:

1.运行根目录下的pom.xml->install (把相关的插件安装到本地,功能完善之后发布到maven就不需要这样了)

2.在本地mysql数据库里创建demo,example数据库,对应application.properties的数据库配置

3.运行resty-example下的pom.xml->flyway-maven-plugin:migration,自动根具resources下db目录下的数据库文件生成数据库表结构

4.运行resty-example下的pom.xml->tomcat7-maven-plugin:run,启动example程序

提醒:推荐idea作为开发ide,使用分模块的多module开发。

源码链接:OSC -> Resty   Github -> Resty

本文出自:http://my.oschina.net/wangrenhui1990/blog/365310

责任编辑:林师授 来源: 王仁辉的博客
相关推荐

2021-10-18 05:00:38

语言GoRequestHTTP

2009-08-21 15:59:22

服务端与客户端通信

2011-09-09 09:44:23

WCF

2009-08-21 16:14:52

服务端与客户端通信

2021-05-25 08:20:37

编程技能开发

2021-08-01 23:18:21

Redis Golang命令

2010-03-18 17:47:07

Java 多客户端通信

2023-03-06 08:01:56

MySQLCtrl + C

2010-11-19 14:22:04

oracle服务端

2009-08-21 15:54:40

服务端与客户端

2009-08-21 15:36:41

服务端与客户端

2023-04-03 08:13:05

MySQLCtrl + C

2014-12-22 11:04:30

Windows AzuiPhone虚拟机

2011-05-18 09:56:31

UbuntuLinux客户端

2015-08-26 17:31:03

UbuntuBT客户端

2019-07-05 17:00:33

Redis数据库可视化管理

2012-11-28 11:05:42

IBMdW

2022-08-09 07:32:03

MySQLWindowsLinux

2010-06-01 13:19:04

2022-09-05 14:36:26

服务端TCP连接
点赞
收藏

51CTO技术栈公众号