Resty 正在参加 2020 年度 OSC 中国开源项目评选,请投票支持!
Resty 在 2020 年度 OSC 中国开源项目评选 中已获得 {{ projectVoteCount }} 票,请投票支持!
投票让它出道
已投票
授权协议 Apache
开发语言 Java
操作系统 跨平台
软件类型 开源软件
所属分类 Web应用开发Web框架
开发厂商
地区 国产
提 交 者 Dreampie
适用人群 未知
收录时间 2015-01-04

软件简介

源码链接:OSC -> Resty   Github -> Resty   在线开发手册

如果你还不是很了解restful,或者认为restful只是一种规范不具有实际意义,推荐一篇osc两年前的文章:RESTful API 设计最佳实践  和 Infoq的一篇极其理论的文章  理解本真的REST架构风格 虽然有点老,介绍的也很简单,大家权当了解,restful的更多好处,还请google

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

部分设计也来自jfinal+activejdbc+restx,也希望大家多多支持开源,开源不比较框架之间的优劣,只描述自己的想法。

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

下载jar包: Resty jar

maven使用方式:
1. 添加maven snapshots仓库

<repositories>
    <repository>
      <id>oss-snapshots</id>
      <url>https://oss.sonatype.org/content/repositories/snapshots</url>
      <releases>
        <enabled>false</enabled>
      </releases>
      <snapshots>
        <enabled>true</enabled>
      </snapshots>
    </repository>
  </repositories>

2. 添加依赖包

<dependency>
    <groupId>cn.dreampie</groupId>
    <artifactId>resty-route</artifactId>
    <version>1.0-SNAPSHOT</version>
</dependency>

重大更新:

Record的时代已经到来,你完全不用使用任何的model来执行你的数据 

//创建record的执行器  针对sec_user表 并开启缓存
Record recordDAO = new Record("sec_user",true);
//使用当前数据源和表数据 new一个对象来保存数据
recordDAO.reNew().set("属性", "值").save();
Record r1 = recordDAO.reNew().set("属性", "值");
Record r2 = recordDAO.reNew().set("属性", "值");
//批量保存
recordDAO.save(r1, r2);
//更新
r2.set("属性", "值").update()
//查询全部
List<Record> records = recordDAO.findAll();
//条件查询
recordDAO.findBy(where,paras)
//分页查询
Page<Record> records = recordDAO.paginateAll();
//根据id删除
recordDAO.deleteById("1");

//本次查询放弃使用cache 
recordDAO.unCache().findBy(where,paras);
//把record的数据源切换到dsName数据源上
recordDAO.useDS(dsName).findBy(where,paras);

//等等,完全摆脱model,实现快速操作数据

//Model支持动态切换数据源和本次查询放弃使用cache

User dao=new User();
//本次查询放弃使用cache 
dao.unCache().findBy(where,paras);
//把model的数据源切换到dsName数据源上
dao.useDS(dsName).findBy(where,paras);

//数据库和全局参数配置移植到application.properties  详情参看resty-example

//not must auto load
app.encoding=UTF-8
app.devMode=true
app.showRoute=true
app.cacheEnabled=true


//druid plugin auto load
//dsName is "default"  you can use everything
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
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


//数据库的配置精简  自动从文件读取参数  只需配置model扫描目录 和dsName
public void configPlugin(PluginLoader pluginLoader) {
  //第一个数据库
  ActiveRecordPlugin activeRecordPlugin = new ActiveRecordPlugin(new DruidDataSourceProvider("default"), true);
  activeRecordPlugin.addIncludePaths("cn.dreampie.resource");
  pluginLoader.add(activeRecordPlugin);
}

一、独有优点:

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,完全融入普通方法的方式
}

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(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.极简的客户端设计,支持各种请求,文件上传和文件下载(支持断点续传)

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());

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());

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<Credential> loadAllCredentials() {
      Set<Credential> credentials = new HashSet<Credential>();
      credentials.add(new Credential("GET", "/api/v1.0/users**", "users"));
      return credentials;
  }
}

6.极简的缓存设计,可扩展,非常简单即可启用model的自动缓存功能

public void configConstant(ConstantLoader constantLoader) {
  //启用缓存并在要自动使用缓存的model上  开启缓存@Table(name = "sec_user", cached = true)
  constantLoader.setCacheEnable(true);
}

@Table(name = "sec_user", cached = true)
public class User extends Model<User> {
  public static User dao = new User();

}

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

@GET("/files")
public File file() {
  return new File(path);
}

8.上传文件,通过@FILE注解件写到服务器

@POST("/files")
@FILE(dir = "/upload/") //配置上传文件的相关信息
public UploadedFile file(UploadedFile file) {    
  return file;
}

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

public void configConstant(ConstantLoader constantLoader) {
  // 通过后缀来返回不同的数据类型  你可以自定义自己的  render  如:FreemarkerRender
  // constantLoader.addRender("json", new JsonRender());
  //默认已添加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开发




展开阅读全文

代码

评论 (20)

加载中
说真的好用,但是使用成本高。有如下几个问题。1:人气不够用旺盛,取名resty,很容易和其他开源软件重名,比如lua-resty,阿里的OpenResty,百度很难收到这个信息。 2:文档不够完善,粗略的用了一下,不是这边少引用jar包就是那边少引用。最好写详细了,我用了一会儿,最后因为这个摒弃了。 3:有的人喜欢用maven。有的人不喜欢maven。特别在作者描述的jar包不够明白时。 4:与jfinal相似,但是功能有一点改变,可是其他相对不完善,插件少,资料少。那为什么要用这个。
2017/07/14 09:31
回复
举报
Dreampie软件作者
绝对简单的restful+activerecord框架 Resty
2015/01/08 23:27
回复
举报
ORM_nosql没有开发? Resty
2015/01/11 09:58
回复
举报
有编译好的jar吗?idea不怎么会用,能否提供下载jar Resty
2015/01/11 10:05
回复
举报
支持,抽空狠狠地研究一下~ Resty
2015/01/12 21:06
回复
举报
Dreampie软件作者
2015/04/23 20:44
回复
举报
Dreampie软件作者
发布maven包,不用本地安装了 #Resty#
2015/04/28 21:31
回复
举报
yak
@Dreampie 每个请求对应的route都是线程安全的吗? #Resty#
2015/04/30 17:40
回复
举报
传递方式 user={json字符串}?这个完全跟restful不搭啊。应该是json以流的形式提交的。 #Resty#
2015/08/03 21:55
回复
举报
在Resource api定义 类中,有提供request 的inputstream流取json数据的方法吗? #Resty#
2015/08/03 22:25
回复
举报
更多评论
发表了资讯
2016/01/17 00:00

RESTful框架Resty(客户端+服务端)进入国外著名极简框架排行榜

Restful极简框架Resty,自上月受到首位俄罗斯用户关注之后,今日被收录至国外一著名(2.5k+star 也许只是收录者的自我感觉,Resty受到认可也是不错的,让我小小的虚荣一把吧 )的极简框架排行榜ListOfMinimalistFrameworks,再度进入国际视野,同时近日github star数达到520,1年时间还是比较满意的,虽然Resty目前文档尚不...

11
84
发表了资讯
2015/12/08 00:00

Resty 1.2.0-SNAPSHOT 更新,可通过header来控制api的版本,数据源读写分离

Resty目前积累到450 star,还有1个多月满一年了,在没有推广的情况下如果能积累到500 star,真是棒棒的,如果觉得不错可以给颗心(https://github.com/Dreampie/Resty),希望大家多多鼓励,也希望有心的同学参与维护,开源说明它属于大家,无论你使用或者作为一个框架的基础学习还是从中得到灵感做出好用的东西 都希望你能...

3
35
发表了资讯
2015/10/12 00:00

Resty 1.1.0-SNAPSHOT 版,极简 restful 框架,快速接入 Spring

Resty从最初开发到现在已经经历了近10个月时间,在github的star数即将进入400,在没有任何推广的情况,目前的情况还是比较可观的,主要感谢关注restful发展的人们。 对于不理解restful的人其实就是一个url地址的规范,但我从来不这么认为,我一直觉得rest是一种理念,就行java教你面向对象一样,rest教你面向资源,不再以...

10
61
发表了资讯
2015/04/28 00:00

Resty 发布 1.0-SNAPSHOT 版,极简RESTful框架

Resty是一款主打restful的极速开发框架,使用activerecord实现orm,使用普通方法作为映射的路由,没有最简单只有更简单 源码链接:OSC -> Resty Github -> Resty 在线开发手册 如果你还不是很了解restful,或者认为restful只是一种规范不具有实际意义,推荐一篇osc两年前的文章:RESTful API 设计最佳实践 和 Infoq的一篇...

2
26
发表了资讯
2015/04/01 00:00

因转 Resty,现寻找 JFinal 相关插件的维护人员

因各方面因素影响,现放弃对 JFinal 插件的维护工作,全力维护新的 restful 框架 Resty (http://git.oschina.net/dreampie/resty Or https://github.com/Dreampie/resty),寻找有心维护插件的用户接手维护工作,大部分插件也很简单,只是需要在反馈到 bug 的时候进行修正。https://github.com/search?q=user%3ADreampie...

91
9
发表了资讯
2015/03/26 00:00

Resty更新新特性 Record 完全取代 model, 数据库配置更简单

重大更新: 1.Record的时代已经到来,你完全不用使用任何的model来执行你的数据 //使用use和useDS 方法来创建record的执行器  针对sec_user表 Record recordDAO = Record.use("sec_user"); //new 一个对象来保存数据 recordDAO.reNew().set("属性", 值).save(); Record r1 = recordDAO.reNew().set("属性", ...

4
17
没有更多内容
加载失败,请刷新页面
点击加载更多
加载中
下一页
发表于开发技能专区
2016/07/21 11:26

resty

https://github.com/Dreampie/resty

0
0
发表了博客
2015/10/28 15:27

Resty使用记录

一:准备工作: 1 安装maven,eclipse安装maven插件(该操作是在eclipse中进行) 2 执行mvn,下载依赖包 3 下载Resty压缩包(git方式导入也可以) 二:开始配置Resty 1 将Resty以maven项目导入eclipse 2 运行根目录下的pom.xml,及右键maven --> install (这一步建议使用命令行:mvn clean install -Dmaven.test.skip=t...

0
0
发表了博客
05/01 09:12

米兰的小铁匠/resty-gateway

resty-gateway github: https://github.com/fengjx/resty-gateway 基于openresty + etcd实现的网关服务 依赖 resty.roundrobin lua-resty-jit-uuid lua-resty-etcd lua-resty-http lua-typeof 整体架构 服务启动时,将自己的节点信息注册到etcd,包括:服务名称、ip、端口 网关服务从etcd监听服务节点信息,保存到缓存中...

0
0
发表了博客
2019/09/02 14:20

lua-resty-kafka配置文档

参考网址:https://github.com/doujiang24/lua-resty-kafka 一、例子 content_by_lua ' -- 引入lua所有api local cjson = require "cjson" local producer = require "resty.kafka.producer" -- 定义kafka broker地址,ip需要和kafka的host.name配置一致 local broker_list = { { host = "192.168.101.223", port = 909...

0
0
发表了博客
2019/09/24 20:13

openresty lua-resty-redis 封装 a wrapper for lua-resty-redis 优雅一点点

搜了一下别人的封装代码,感觉不够优雅,主要是 set_keepalive 的调用时机不太好 我自己下面的代码是利用 coroutine, 每次当前 phase 结束后自动调用 set_keepalive local redis = require "resty.redis" local M = {} local function set_keepalive(p, red, opts)   while true do     if 'dead' == coroutine.status(...

0
0
发表了博客
09/01 08:39

爱奇艺开源lua-resty-couchbase

使用cosocket纯lua实现的couchbase的client,已经在爱奇艺重要的播放服务稳定运行5年多,线上支持峰值QPS达到20W,在OpenResty架构下面,可以直接从nginx上面访问CouchBase. 开源地址:https://github.com/iqiyi/...

0
0
发表了博客
2019/03/08 13:45

试用 openresty/lua-resty-shell

openresty/lua-resty-shell 是当前最新rc 版本内置的shell 功能,我们可以用来执行一个脚本,以及命令 还是比较方便的。 测试集成了一个oreilly电子书下载的功能 环境准备 docker-compose 文件 version: "3" services: nginx: build: ./ ports: - "8888:8080" env_file: - .account.env ...

0
0
发表于服务端专区
2015/01/08 22:33

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

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

67
280
发表了博客
2019/12/30 08:40

如何使用resty命令行客户端和http rest服务进行交互

本文首发于个人博客https://kezunlin.me/post/4f5f98b9/,欢迎阅读最新内容! how to install and use resty command line client for interacting with rest services Guide install You have curl, right? Okay......

0
0
发表于AI & 大数据专区
2017/01/11 16:57

openresty lua-resty-template 简单应用

local template = require("resty.template") local cjson = require("cjson") local arg = ngx.req.get_uri_args(); local res = ngx.location.capture('/article/info?id=' .. arg.id) if res.status == 200 then   local obj = cjson.decode(res.body) template.render("article_info.html",{par=arg,content=...

0
0
没有更多内容
加载失败,请刷新页面
点击加载更多
加载中
下一页
发表了问答
2016/09/08 18:40

请教下 使用resty遇到的几个问题

@Dreampie 你好,想跟你请教个问题: 1.数据库id是自增的,保存数据时如何获取保存后的数据iD。 2.Resource里的方法接收参数能自动将json转换为对象吗 如{a:1,b:{bb:1,dd:2}} 我试了 b 这个属性就不能转换了 3.提交一个json数据在Resource里能对提交的数据数据验证吗? 如spring的注解验证。...

1
0
发表了问答
2016/07/21 20:20

关于多数据源的事务控制

@Dreampie 你好,想跟你请教个问题: 刚才拜读了下resty的源码,看到关于多数据源事物控制实现的核心是如下的(TransactionAspect类中): for (int i = 0; i < names.length; i++) { dataSourceMeta = Metadata.getDataSourceMeta(names[i]); dataSourceMeta.initTransaction(readonlys.length ==...

5
0
发表了问答
2015/10/23 12:06

使用paginate查询oracle时出错

@Dreampie 你好,想跟你请教个问题: 在使用resty进行分页查询时报错,使用的是oracle数据库,驱动包为ojdbc6.jar,提示无效字符 在plsql中对sql进行调试,发现是别名中的前缀下划线造成的,调整别名,就可正常查询。 [SQL]SELECT * FROM ( SELECT _row.*, ROWNUM rownum_ FROM (SELECT * FROM BL_SP_USERINFO) _row WH...

1
0
发表了问答
2015/09/06 17:41

使用postgresql时报的异常

@Dreampie 你好,想跟你请教个问题: 在调用Account.dao.findAll()时报如下错误。 execute error. SELECT * FROM sso_user org.postgresql.util.PSQLException: ERROR: syntax error at or near "RETURNING" 采用的驱动为 <dependency> <groupId>org.postgresql</groupId> <artifactId>postgresql</artifactId> <versio...

4
0
发表了问答
2015/01/25 23:49

运行过程中碰到的几个小问题

执行这一段时,报错 new User().set("username", "test") Could not found ModelMetadata for this model:cn.dreampie.example.model.User 另外这个user,不知道怎么注入,还望指导下 @POST("/users") public User save(User user) { User u = new User().set("username", "test").set("providername", "test").set("p...

4
0
发表了问答
2015/01/23 16:21

不使用事务的时候关闭数据库连接可能有点问题

好像会重新获取一个,然后关闭这个刚获取的,之前那个没管

4
0
发表了问答
2015/01/23 13:25

请问Resty的orm-sql中model的update方法是不是忘了把id的值放在param里了?

请问Resty的orm-sql中model的update方法是不是忘了把id的值放在param里了? 调用model.update();时报异常 java.sql.SQLException: No value specified for parameter 4

2
0
没有更多内容
加载失败,请刷新页面
点击加载更多
加载中
下一页
20 评论
283 收藏
分享
返回顶部
顶部