# Resty **Repository Path**: HHcoder/Resty ## Basic Information - **Project Name**: Resty - **Description**: sample restful framework - **Primary Language**: Unknown - **License**: Apache-2.0 - **Default Branch**: master - **Homepage**: None - **GVP Project**: No ## Statistics - **Stars**: 0 - **Forks**: 44 - **Created**: 2016-10-11 - **Last Updated**: 2024-05-30 ## Categories & Tags **Categories**: Uncategorized **Tags**: None ## README Resty 一款极简的restful轻量级的web框架 =========== [![Join the chat at https://gitter.im/Dreampie/Resty](https://badges.gitter.im/Join%20Chat.svg)](https://gitter.im/Dreampie/Resty?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge) [![Issue Stats](http://issuestats.com/github/Dreampie/Resty/badge/pr?style=flat)](http://issuestats.com/github/Dreampie/Resty) [![Issue Stats](http://issuestats.com/github/Dreampie/Resty/badge/issue?style=flat)](http://issuestats.com/github/Dreampie/Resty) 开发文档 如果你还不是很了解restful，或者认为restful只是一种规范不具有实际意义，推荐一篇osc两年前的文章：[RESTful API 设计最佳实践](http://www.oschina.net/translate/best-practices-for-a-pragmatic-restful-api) 和 Infoq的一篇极其理论的文章 [理解本真的REST架构风格](http://www.infoq.com/cn/articles/understanding-restful-style) 虽然有点老，介绍的也很简单，大家权当了解，restful的更多好处，还请google 拥有jfinal/activejdbc一样的activerecord的简洁设计，使用更简单的restful框架 restful的api设计，是作为restful的服务端最佳选择（使用场景：客户端和服务端解藕，用于对静态的html客户端（mvvm等），ios，andriod等提供服务端的api接口） Java开发指南:[Java style guide](https://github.com/Dreampie/java-style-guide) Api设计指南:[Http api design](https://github.com/Dreampie/http-api-design-ZH_CN) Resty例子：[resty-demo](https://github.com/Dreampie/resty-demo) 开发群: 极简Restful框架 - Resty 其他开发者贡献的插件:[Beetl扩展(大鹏)](https://github.com/zhaopengme/Resty-ext) [Shiro扩展(zhoulieqing)](http://git.oschina.net/zhoulieqing/resty-shiro) [MongoPlugin(T-baby)](https://github.com/T-baby/MongoDB-Plugin) maven使用方式： 1. 添加依赖包 ```xml cn.dreampie resty-route 1.3.0-SNAPSHOT ``` 2.如果使用带有-SNAPSHOT后缀的包，请添加该仓库 ```xml oss-snapshots https://oss.sonatype.org/content/repositories/snapshots true true ``` 一、独有优点： ----------- 重大更新： 1.3.0更新内容： 使用jetty作为嵌入式热加载默认实现(只要java文件进行编译就会重新加载)，resty-captcha验证码功能... 1.2.0更新内容：使用header来控制api版本，基于数据源的读写分离，更简单的tableSetting.[详情查看](http://www.oschina.net/news/68791/resty-1-2-0-snapshot) 1.1.0版本重大更新：快速接入spring，缓存，加密，header，XForwardedSupports等，[详情查看](http://www.oschina.net/news/67001/resty-1-1-0-snapshot) Record的时代已经到来，你完全不用使用任何的model来执行你的数据 ```java //创建record的执行器 针对sec_user表 并开启缓存 Record recordDAO = new Record("sec_user"); //使用当前数据源和表数据 new一个对象来保存数据 recordDAO.reNew().set("属性", "值").save(); Record r1 = recordDAO.reNew().set("属性", "值"); Record r2 = recordDAO.reNew().set("属性", "值"); //批量保存 recordDAO.save(r1, r2); //更新 r2.set("属性", "值").update() //查询全部 List records = recordDAO.findAll(); //条件查询 recordDAO.findBy(where,paras) //分页查询 Page records = recordDAO.paginateAll(); //根据id删除 recordDAO.deleteById("1"); //本次查询放弃使用cache recordDAO.unCache().findBy(where,paras); //把record的数据源切换到dsmName数据源上 recordDAO.useDS(dsmName).findBy(where,paras); //等等，完全摆脱model，实现快速操作数据 ``` Model支持动态切换数据源和本次查询放弃使用cache ```java User dao=new User(); //本次查询放弃使用cache dao.unCache().findBy(where,paras); //把model的数据源切换到dsmName数据源上 dao.useDS(dsmName).findBy(where,paras); ``` //数据库和全局参数配置移植到application.properties 详情参看resty-example ```java #not must auto load app.encoding=UTF-8 app.devEnable=true app.showRoute=false app.cacheEnabled=true #默认使用ehcacheProvider #app.cacheProvider=cn.dreampie.cache.redis.RedisProvider ##druid plugin auto load db.default.url=jdbc:mysql://127.0.0.1/example?useUnicode=true&characterEncoding=UTF-8 db.default.user=dev db.default.password=dev1010 db.default.dialect=mysql #c3p0配置 c3p0.default.minPoolSize=3 c3p0.default.maxPoolSize=20 #druid配置 #druid.default.initialSize=10 #druid.default.maxPoolPreparedStatementPerConnectionSize=20 #druid.default.timeBetweenConnectErrorMillis=1000 #druid.default.filters=slf4j,stat,wall #flyway database migration auto load flyway.default.valid.clean=true flyway.default.migration.auto=true flyway.default.migration.initOnMigrate=true db.demo.url=jdbc:mysql://127.0.0.1/demo?useUnicode=true&characterEncoding=UTF-8 db.demo.user=dev db.demo.password=dev1010 db.demo.dialect=mysql #druid druid.demo.initialSize=10 druid.demo.maxPoolPreparedStatementPerConnectionSize=20 druid.demo.timeBetweenConnectErrorMillis=1000 druid.demo.filters=slf4j,stat,wall #flyway flyway.demo.valid.clean=true flyway.demo.migration.auto=true flyway.demo.migration.initOnMigrate=true //数据库的配置精简 自动从文件读取参数 只需配置model扫描目录 和dsmName public void configPlugin(PluginLoader pluginLoader) { //第一个数据库 ActiveRecordPlugin activeRecordPlugin = new ActiveRecordPlugin(new DruidDataSourceProvider("default"), true); activeRecordPlugin.addIncludePaths("cn.dreampie.resource"); pluginLoader.add(activeRecordPlugin); } ``` 1.极简的route设计，完全融入普通方法的方式，方法参数就是请求参数，方法返回值就是数据返回值 ```java @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 } ``` 2.极简的activerecord设计，数据操作只需短短的一行,支持批量保存对象 ```java //批量保存 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(columns,where,paras); User.dao.updateAll(columns,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); ``` 3.极简的客户端设计，支持各种请求，文件上传和文件下载（支持断点续传） ```java Client httpClient=null;//创建客户端对象 //启动resty-example项目，即可测试客户端 String apiUrl = "http://localhost:8081/api/v1.0"; //如果不需要 使用账号登陆 //httpClient = new Client(apiUrl); //如果有账号权限限制 需要登陆 httpClient = new Client(apiUrl, "/tests/login", "u", "123"); //该请求必须 登陆之后才能访问 未登录时返回 401 未认证 ClientRequest authRequest = new ClientRequest("/users"); ClientResult authResult = httpClient.build(authRequest).get(); System.out.println(authResult.getResult()); //get ClientRequest getRequest = new ClientRequest("/tests"); ClientResult getResult = httpClient.build(getRequest).get(); System.out.println(getResult.getResult()); //post ClientRequest postRequest = new ClientRequest("/tests"); postRequest.addParam("test", Jsoner.toJSONString(Maper.of("a", "谔谔"))); ClientResult postResult = httpClient.build(postRequest).post(); System.out.println(postResult.getResult()); //put ClientRequest putRequest = new ClientRequest("/tests/x"); ClientResult putResult = httpClient.build(putRequest).put(); System.out.println(putResult.getResult()); //delete ClientRequest deleteRequest = new ClientRequest("/tests/a"); ClientResult deleteResult = httpClient.build(deleteRequest).delete(); System.out.println(deleteResult.getResult()); //upload ClientRequest uploadRequest = new ClientRequest("/tests/resty"); uploadRequest.addUploadFiles("resty", ClientTest.class.getResource("/resty.jar").getFile()); uploadRequest.addParam("des", "test file paras 测试笔"); ClientResult uploadResult = httpClient.build(uploadRequest).post(); System.out.println(uploadResult.getResult()); //download 支持断点续传 ClientRequest downloadRequest = new ClientRequest("/tests/file"); downloadRequest.setDownloadFile(ClientTest.class.getResource("/resty.jar").getFile().replace(".jar", "x.jar")); ClientResult downloadResult = httpClient.build(downloadRequest).get(); System.out.println(downloadResult.getResult()); ``` 4.支持多数据源和嵌套事务（使用场景：需要访问多个数据库的应用，或者作为公司内部的数据中间件向客户端提供数据访问api等） ```java // 在resource里使用事务,也就是controller里，rest的世界认为所以的请求都表示资源，所以这儿叫resource @GET("/users") @Transaction(name = {"default", "demo"}) //多数据源的事务，如果你只有一个数据库 直接@Transaction 不需要参数 public User transaction() { //TODO 用model执行数据库的操作 只要有操作抛出异常 两个数据源 都会回滚 虽然不是分布式事务 也能保证代码块的数据执行安全 } // 如果你需要在service里实现事务，通过java动态代理（必须使用接口，jdk设计就是这样） public interface UserService { @Transaction(name = {"demo"})//service里添加多数据源的事务，如果你只有一个数据库 直接@Transaction 不需要参数 public User save(User u); } // 在resource里使用service层的 事务 // @Transaction(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()); ``` 5.极简的权限设计,可以通过cache支持分布式session，你只需要实现一个简单接口和添加一个拦截器，即可实现基于url的权限设计 ```java 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() {{ add("api"); }}); return principal; } //基础的权限总表 所以的url权限都放在这儿 你可以通过 文件或者数据库或者直接代码 来设置所有权限 public Set loadAllCredentials() { Set credentials = new HashSet(); credentials.add(new Credential("GET", "/api/v1.0/users**", "users")); return credentials; } } ``` 6.极简的缓存设计，可扩展，非常简单即可启用model的自动缓存功能 ```java //启用缓存并在要自动使用缓存的model上 //config application.properties app.cacheEnabled=true //开启缓存@Table(name = "sec_user", cached = true) @Table(name = "sec_user", cached = true) public class User extends Model { public static User dao = new User(); } ``` 7.下载文件，只需要直接return file ```java @GET("/files") public File file() { return new File(path); } ``` 8.上传文件，注解配置把文件写到服务器 ```java @POST("/files") @FILE(dir = "/upload/") //配置上传文件的相关信息 public UploadedFile file(UploadedFile file) { return file; } ``` 9.当然也是支持传统的web开发，你可以自己实现数据解析，在config里添加自定义的解析模板 ```java public void configConstant(ConstantLoader constantLoader) { // 通过后缀来返回不同的数据类型 你可以自定义自己的 render 如：FreemarkerRender //默认已添加json和text的支持，只需要把自定义的Render add即可 // constantLoader.addRender("json", new JsonRender()); } ``` 二、运行example示例： ----------------- 1.在本地mysql数据库里创建demo,example数据库，对应application.properties的数据库配置 2.运行resty-example下的pom.xml->flyway-maven-plugin:migrate，自动根具resources下db目录下的数据库文件生成数据库表结构 3.运行resty-example下的pom.xml->tomcat6-maven-plugin:run,启动example程序 提醒:推荐idea作为开发ide，使用分模块的多module开发 License Apache License V2 捐赠： [支付宝](https://raw.githubusercontent.com/Dreampie/Resty/master/alipay.png)