文档章节

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

Dreampie
 Dreampie
发布于 2015/01/08 22:33
字数 2068
阅读 12491
收藏 281

源码链接: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开发




© 著作权归作者所有

Dreampie
粉丝 292
博文 23
码字总数 16536
作品 6
朝阳
其他
私信 提问
加载中

评论(67)

byteuser19
byteuser19
从jFinal过来好好学习一下
Dreampie
Dreampie 博主

引用来自“lyle_luo”的评论

你这样,波总知道吗?
当然
lyle_luo
lyle_luo
你这样,波总知道吗?
喵小强
喵小强
mark...
Dreampie
Dreampie 博主

引用来自“道在何方”的评论

功力深厚!

0客气,大家互相交流
道在何方
道在何方
功力深厚!
混世顽童
混世顽童

引用来自“王仁辉(java)”的评论

引用来自“混世顽童”的评论

谢谢支持0

如果客户端程序可以实现动态代理模式就好了
Dreampie
Dreampie 博主

引用来自“Dearchen”的评论

这个很好!开源更好!不懂可以研究源码!支持0

谢谢支持,也是推荐大家一起看源码,有问题大家一起进步0
最新动弹
最新动弹
这个很好!开源更好!不懂可以研究源码!支持0
Dreampie
Dreampie 博主

引用来自“MadisonRong”的评论

这是跟JF结合使用的吗?还得单独使用的

单独的,不用使用jfinal的任何不部分0
极简的RESTful框架(服务端+客户端)--Resty

源码链接:OSC -> Resty Github -> Resty 在线开发手册 如果你还不是很了解restful,或者认为restful只是一种规范不具有实际意义,推荐一篇osc两年前的文章:RESTful API 设计最佳实践 和 In...

Dreampie
2015/01/04
20.8K
20
RESTful框架Resty(客户端+服务端)进入国外著名极简框架排行榜

Restful极简框架Resty,自上月受到首位俄罗斯用户关注之后,今日被收录至国外一著名(2.5k+star 也许只是收录者的自我感觉,Resty受到认可也是不错的,让我小小的虚荣一把吧 )的极简框架排行榜...

Dreampie
2016/01/17
5.6K
11
Resty 发布 1.0-SNAPSHOT 版,极简RESTful框架

Resty是一款主打restful的极速开发框架,使用activerecord实现orm,使用普通方法作为映射的路由,没有最简单只有更简单 源码链接:OSC -> Resty Github -> Resty 在线开发手册 如果你还不是很...

Dreampie
2015/04/28
1K
2
OSChina 技术周刊第十八期 —— 2015 年 OSC 源创会行程计划

每周技术抢先看,总有你想要的! 移动开发 【软件】开源 Android ORM 框架 OpenDroid 【博客】自己动手做推送 前端开发 【软件】jQuery 全屏滚动插件 fullPage.js 服务端开发/管理 【软件】W...

OSC编辑部
2015/01/18
1K
0
OSChina 技术周刊第十八期

每周技术抢先看,总有你想要的! 移动开发 【软件】开源 Android ORM 框架 OpenDroid 【博客】自己动手做推送 前端开发 【软件】jQuery 全屏滚动插件 fullPage.js 服务端开发/管理 【软件】W...

OSC编辑部
2015/01/18
518
0

没有更多内容

加载失败,请刷新页面

加载更多

redis 学习2

网站 启动 服务端 启动redis 服务端 在redis 安装目录下 src 里面 ./redis-server & 可以指定 配置文件或者端口 客户端 在 redis 的安装目录里面的 src 里面 ./redis-cli 可以指定 指定 连接...

之渊
今天
2
0
Spring boot 静态资源访问

0. 两个配置 spring.mvc.static-path-patternspring.resources.static-locations 1. application中需要先行的两个配置项 1.1 spring.mvc.static-path-pattern 这个配置项是告诉springboo......

moon888
今天
4
0
hash slot(虚拟桶)

在分布式集群中,如何保证相同请求落到相同的机器上,并且后面的集群机器可以尽可能的均分请求,并且当扩容或down机的情况下能对原有集群影响最小。 round robin算法:是把数据mod后直接映射...

李朝强
今天
4
0
Kafka 原理和实战

本文首发于 vivo互联网技术 微信公众号 https://mp.weixin.qq.com/s/bV8AhqAjQp4a_iXRfobkCQ 作者简介:郑志彬,毕业于华南理工大学计算机科学与技术(双语班)。先后从事过电子商务、开放平...

vivo互联网技术
今天
24
0
java数据类型

基本类型: 整型:Byte,short,int,long 浮点型:float,double 字符型:char 布尔型:boolean 引用类型: 类类型: 接口类型: 数组类型: Byte 1字节 八位 -128 -------- 127 short 2字节...

audience_1
今天
9
0

没有更多内容

加载失败,请刷新页面

加载更多

返回顶部
顶部