摘要：源碼鏈接開(kāi)發(fā)文檔如果你還不是很了解，或者認(rèn)為只是一種規(guī)范不具有實(shí)際意義，推薦一篇兩年前的文章設(shè)計(jì)最佳實(shí)踐和的一篇極其理論的文章理解本真的架構(gòu)風(fēng)格雖然有點(diǎn)老，介紹的也很簡(jiǎn)單，大家權(quán)當(dāng)了解，的更多好處，還請(qǐng)擁有一樣的的簡(jiǎn)潔設(shè)計(jì)，使用更簡(jiǎn)單的框架

源碼鏈接：Resty 開(kāi)發(fā)文檔

如果你還不是很了解restful，或者認(rèn)為restful只是一種規(guī)范不具有實(shí)際意義，推薦一篇osc兩年前的文章：RESTful API 設(shè)計(jì)最佳實(shí)踐 和 Infoq的一篇極其理論的文章 理解本真的REST架構(gòu)風(fēng)格 雖然有點(diǎn)老，介紹的也很簡(jiǎn)單，大家權(quán)當(dāng)了解，restful的更多好處，還請(qǐng)google

擁有jfinal/activejdbc一樣的activerecord的簡(jiǎn)潔設(shè)計(jì)，使用更簡(jiǎn)單的restful框架

restful的api設(shè)計(jì)，是作為restful的服務(wù)端最佳選擇（使用場(chǎng)景：客戶(hù)端和服務(wù)端解藕，用于對(duì)靜態(tài)的html客戶(hù)端（mvvm等），ios，andriod等提供服務(wù)端的api接口）

提醒：因框架還在開(kāi)發(fā)第一個(gè)正式項(xiàng)目，所以會(huì)有細(xì)微調(diào)整，更新提醒頻繁，所以star時(shí)關(guān)閉watch，或者您可以在個(gè)人設(shè)置->Notification center->Watching->Email 關(guān)閉郵件提醒，感謝您的理解和支持

開(kāi)發(fā)群:

下載jar包：Resty相關(guān)jar

maven使用方式:

1.添加maven snapshots倉(cāng)庫(kù)

xml
    
      oss-snapshots
      https://oss.sonatype.org/content/repositories/snapshots
      
        false
      
      
        true
      
    
  

xml
    cn.dreampie
    resty-route
    1.0-SNAPSHOT

java//創(chuàng)建record的執(zhí)行器  針對(duì)sec_user表 并開(kāi)啟緩存
Record recordDAO = new Record("sec_user",true);
//使用當(dāng)前數(shù)據(jù)源和表數(shù)據(jù) new一個(gè)對(duì)象來(lái)保存數(shù)據(jù)
recordDAO.reNew().set("屬性", "值").save();
Record r1 = recordDAO.reNew().set("屬性", "值");
Record r2 = recordDAO.reNew().set("屬性", "值");
//批量保存
recordDAO.save(r1, r2);
//更新
r2.set("屬性", "值").update()
//查詢(xún)?nèi)?List records = recordDAO.findAll();
//條件查詢(xún)
recordDAO.findBy(where,paras)
//分頁(yè)查詢(xún)
Page records = recordDAO.paginateAll();
//根據(jù)id刪除
recordDAO.deleteById("1");

//本次查詢(xún)放棄使用cache 
recordDAO.unCache().findBy(where,paras);
//把record的數(shù)據(jù)源切換到dsName數(shù)據(jù)源上
recordDAO.useDS(dsName).findBy(where,paras);

//等等，完全擺脫model，實(shí)現(xiàn)快速操作數(shù)據(jù)

javaUser dao=new User();
//本次查詢(xún)放棄使用cache 
dao.unCache().findBy(where,paras);
//把model的數(shù)據(jù)源切換到dsName數(shù)據(jù)源上
dao.useDS(dsName).findBy(where,paras);

java#not must auto load
app.encoding=UTF-8
app.devMode=true
app.showRoute=false
app.cacheEnabled=true
#默認(rèn)使用ehcacheManager
#app.cacheManager=cn.dreampie.cache.redis.RedisManager

##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



//數(shù)據(jù)庫(kù)的配置精簡(jiǎn)  自動(dòng)從文件讀取參數(shù)  只需配置model掃描目錄 和dsName
public void configPlugin(PluginLoader pluginLoader) {
  //第一個(gè)數(shù)據(jù)庫(kù)
  ActiveRecordPlugin activeRecordPlugin = new ActiveRecordPlugin(new DruidDataSourceProvider("default"), true);
  activeRecordPlugin.addIncludePaths("cn.dreampie.resource");
  pluginLoader.add(activeRecordPlugin);
}

java  @GET("/users/:name")
  //在路徑中自定義解析的參數(shù) 如果有其他符合 也可以用 /users/{name}
  // 參數(shù)名就是方法變量名  除路徑參數(shù)之外的參數(shù)也可以放在方法參數(shù)里  傳遞方式 user={json字符串}
  public Map find(String name,User user) {
    // return Lister.of(name);
    return Maper.of("k1", "v1,name:" + name, "k2", "v2");
    //返回什么數(shù)據(jù)直接return
  }

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

  //查詢(xún)
  User.dao.findById(id);
  User.dao.findBy(where,paras);
  User.dao.findAll();

  //分頁(yè)
  User.dao.paginateBy(pageNumber,pageSize,where,paras);
  User.dao.paginateAll(pageNumber,pageSize);

java  Client client=null;//創(chuàng)建客戶(hù)端對(duì)象
  //啟動(dòng)resty-example項(xiàng)目，即可測(cè)試客戶(hù)端
  String apiUrl = "http://localhost:8081/api/v1.0";
  //如果不需要 使用賬號(hào)登陸
  //client = new Client(apiUrl);
  //如果有賬號(hào)權(quán)限限制  需要登陸
  client = new Client(apiUrl, "/tests/login", "u", "123");

  //該請(qǐng)求必須  登陸之后才能訪(fǎng)問(wèn)  未登錄時(shí)返回 401  未認(rèn)證
  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.addParam("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.addParam("des", "test file  paras  測(cè)試筆");
  ResponseData uploadResult = client.build(uploadRequest).ask();
  System.out.println(uploadResult.getData());


  //download  支持?jǐn)帱c(diǎn)續(xù)傳
  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());

java  // 在resource里使用事務(wù),也就是controller里，rest的世界認(rèn)為所以的請(qǐng)求都表示資源，所以這兒叫resource
  @GET("/users")
  @Transaction(name = {"default", "demo"}) //多數(shù)據(jù)源的事務(wù)，如果你只有一個(gè)數(shù)據(jù)庫(kù)  直接@Transaction 不需要參數(shù)
  public User transaction() {
  //TODO 用model執(zhí)行數(shù)據(jù)庫(kù)的操作  只要有操作拋出異常  兩個(gè)數(shù)據(jù)源 都會(huì)回滾  雖然不是分布式事務(wù)  也能保證代碼塊的數(shù)據(jù)執(zhí)行安全
  }

  // 如果你需要在service里實(shí)現(xiàn)事務(wù)，通過(guò)java動(dòng)態(tài)代理（必須使用接口，jdk設(shè)計(jì)就是這樣）
  public interface UserService {
    @Transaction(name = {"demo"})//service里添加多數(shù)據(jù)源的事務(wù)，如果你只有一個(gè)數(shù)據(jù)庫(kù)  直接@Transaction 不需要參數(shù)
    public User save(User u);
  }
  // 在resource里使用service層的 事務(wù)
  // @Transaction(name = {"demo"})的注解需要寫(xiě)在service的接口上
  // 注意java的自動(dòng)代理必須存在接口
  // TransactionAspect 是事務(wù)切面 ，你也可以實(shí)現(xiàn)自己的切面比如日志的Aspect，實(shí)現(xiàn)Aspect接口
  // 再private UserService userService = AspectFactory.newInstance(new UserServiceImpl(), new TransactionAspect(),new LogAspect());
  private UserService userService = AspectFactory.newInstance(new UserServiceImpl(), new TransactionAspect());

java  public void configInterceptor(InterceptorLoader interceptorLoader) {
    //權(quán)限攔截器 放在第一位 第一時(shí)間判斷 避免執(zhí)行不必要的代碼
    interceptorLoader.add(new SecurityInterceptor(new MyAuthenticateService()));
  }

  //實(shí)現(xiàn)接口
  public class MyAuthenticateService implements AuthenticateService {
    //登陸時(shí) 通過(guò)name獲取用戶(hù)的密碼和權(quán)限信息
    public Principal findByName(String name) {
      DefaultPasswordService defaultPasswordService = new DefaultPasswordService();

      Principal principal = new Principal(name, defaultPasswordService.hash("123"), new HashSet() {{
        add("api");
      }});
      return principal;
    }
    //基礎(chǔ)的權(quán)限總表  所以的url權(quán)限都放在這兒  你可以通過(guò) 文件或者數(shù)據(jù)庫(kù)或者直接代碼 來(lái)設(shè)置所有權(quán)限
    public Set loadAllCredentials() {
      Set credentials = new HashSet();
      credentials.add(new Credential("GET", "/api/v1.0/users**", "users"));
      return credentials;
    }
  }

java  //啟用緩存并在要自動(dòng)使用緩存的model上
  //config application.properties  app.cacheEnabled=true
  //開(kāi)啟緩存@Table(name = "sec_user", cached = true)

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

  }

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

java  @POST("/files")
  @FILE(dir = "/upload/") //配置上傳文件的相關(guān)信息
  public UploadedFile file(UploadedFile file) {
    return file;
  }

java  public void configConstant(ConstantLoader constantLoader) {
    // 通過(guò)后綴來(lái)返回不同的數(shù)據(jù)類(lèi)型  你可以自定義自己的  render  如：FreemarkerRender
    //默認(rèn)已添加json和text的支持，只需要把自定義的Render add即可
    // constantLoader.addRender("json", new JsonRender());
  }