restful版的Jfinal之Resty

2023-11-18 09:29:00 浏览数 (1)

前言碎语

自昨晚9点发现了resty后，一直考究到深夜3点才睡，只想说这6个小时的体验博主内心是满足的！说resty是restful版的Jfinal之Resty，其实有点过了，只是大部分人知道Jfinal，不一定知道还有个resty，resty的框架设计大量借鉴了Jfinal极简开发的思想，先抛开resty是否有重复造轮子之嫌！就作者写了大量的Jfinal插件后，提炼出针对restful开发的resty来，我觉得还是有意义的。而且，正好博主近期在开发一个app的一个项目，需要写接口给客户端调用，对比下来发现resty针对这个事情帮你想好了很多东西。对于接触过Jfinal的朋友来说，使用resty开发是件so easy的事情， 下面是官方实例，大家感受下

作者的Jfinal插件地址：https://github.com/Dreampie/jfinal-dreampie

resty开发文档：https://dreampie.gitbooks.io/

官方实例

maven使用方式：

  1. 添加依赖包
代码语言：javascript复制
<dependency>
    <groupId>cn.dreampiegroupId>
    <artifactId>resty-routeartifactId>
    <version>1.0version>
dependency>

2.如果使用带有-SNAPSHOT后缀的包，请添加该仓库

代码语言：javascript复制
<repositories>
    <repository>
      <id>oss-snapshotsid>
      <url>https://oss.sonatype.org/content/repositories/snapshotsurl>
      <releases>
        <enabled>trueenabled>
      releases>
      <snapshots>
        <enabled>trueenabled>
      snapshots>
    repository>
  repositories>

一、独有优点：

重大更新：

1.2.0更新内容：使用header来控制api版本，基于数据源的读写分离，更简单的tableSetting.详情查看

1.1.0版本重大更新：快速接入spring，缓存，加密，header，XForwardedSupports等，详情查看

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

代码语言：javascript复制
//创建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<Record> records = recordDAO.findAll(); //条件查询 recordDAO.findBy(where,paras) //分页查询 Page<Record> records = recordDAO.paginateAll(); //根据id删除 recordDAO.deleteById("1"); //本次查询放弃使用cache  recordDAO.unCache().findBy(where,paras); //把record的数据源切换到dsmName数据源上 recordDAO.useDS(dsmName).findBy(where,paras); //等等，完全摆脱model，实现快速操作数据

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

代码语言：javascript复制
User dao=new User(); //本次查询放弃使用cache  dao.unCache().findBy(where,paras); //把model的数据源切换到dsmName数据源上 dao.useDS(dsmName).findBy(where,paras);

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

代码语言：javascript复制
#not must auto load
app.encoding=UTF-8 app.devMode=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设计，完全融入普通方法的方式，方法参数就是请求参数，方法返回值就是数据返回值

代码语言：javascript复制
  @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设计，数据操作只需短短的一行,支持批量保存对象

代码语言：javascript复制
  //批量保存 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.极简的客户端设计，支持各种请求，文件上传和文件下载（支持断点续传）

代码语言：javascript复制
  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"); ClientResult authResult = client.build(authRequest).get(); System.out.println(authResult.getResult()); //get ClientRequest getRequest = new ClientRequest("/tests"); ClientResult getResult = client.build(getRequest).get(); System.out.println(getResult.getResult()); //post ClientRequest postRequest = new ClientRequest("/tests");
  postRequest.addParam("test", Jsoner.toJSONString(Maper.of("a", "谔谔"))); ClientResult postResult = client.build(postRequest).post(); System.out.println(postResult.getResult()); //put ClientRequest putRequest = new ClientRequest("/tests/x"); ClientResult putResult = client.build(putRequest).put(); System.out.println(putResult.getResult()); //delete ClientRequest deleteRequest = new ClientRequest("/tests/a"); ClientResult deleteResult = client.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 = client.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 = client.build(downloadRequest).get(); System.out.println(downloadResult.getResult());

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

代码语言：javascript复制
  // 在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的权限设计

代码语言：javascript复制
  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的自动缓存功能

代码语言：javascript复制
  //启用缓存并在要自动使用缓存的model上 //config application.properties  app.cacheEnabled=true //开启缓存@Table(name = "sec_user", cached = true) @Table(name = "sec_user", cached = true) public class User extends Model<User> { public static User dao = new User();

  }

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

代码语言：javascript复制
  @GET("/files") public File file() { return new File(path);
  }

8.上传文件，注解配置把文件写到服务器

代码语言：javascript复制
  @POST("/files")
  @FILE(dir = "/upload/") //配置上传文件的相关信息 public UploadedFile file(UploadedFile file) { return file;
  }

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

代码语言：javascript复制
  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开发

数据库 restful 配置 权限 数据

0 人点赞