極簡的Restful框架推薦->Resty

源碼連接：Resty 開發文檔

若是你還不是很瞭解restful，或者認爲restful只是一種規範不具備實際意義，推薦一篇osc兩年前的文章：RESTful API 設計最佳實踐 和 Infoq的一篇極其理論的文章 理解本真的REST架構風格 雖然有點老，介紹的也很簡單，你們權當了解，restful的更多好處，還請google

擁有jfinal/activejdbc同樣的activerecord的簡潔設計，使用更簡單的restful框架

restful的api設計，是做爲restful的服務端最佳選擇（使用場景：客戶端和服務端解藕，用於對靜態的html客戶端（mvvm等），ios，andriod等提供服務端的api接口）

提醒：因框架還在開發第一個正式項目，因此會有細微調整，更新提醒頻繁，因此star時關閉watch，或者您能夠在我的設置->Notification center->Watching->Email 關閉郵件提醒，感謝您的理解和支持

開發羣:

下載jar包：Resty相關jar

maven使用方式:

1.添加maven snapshots倉庫

xml<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.添加依賴包

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

1、獨有優勢：

重大更新：

Record的時代已經到來，你徹底不用使用任何的model來執行你的數據

java//建立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

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

//數據庫和全局參數配置移植到application.properties 詳情參看resty-example

java#not must auto load
app.encoding=UTF-8
app.devMode=true
app.showRoute=false
app.cacheEnabled=true
#默認使用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



//數據庫的配置精簡  自動從文件讀取參數  只需配置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設計，徹底融入普通方法的方式，方法參數就是請求參數，方法返回值就是數據返回值

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.極簡的客戶端設計，支持各類請求，文件上傳和文件下載（支持斷點續傳）

javaClient 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.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  測試筆");
  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等）

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的權限設計

javapublic 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的自動緩存功能

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<User> {
    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裏添加自定義的解析模板

javapublic void configConstant(ConstantLoader constantLoader) {
    // 經過後綴來返回不一樣的數據類型  你能夠自定義本身的  render  如：FreemarkerRender
    //默認已添加json和text的支持，只須要把自定義的Render add便可
    // constantLoader.addRender("json", new JsonRender());
  }

2、運行example示例：

1.運行根目錄下的pom.xml->install （命令行： mvn clean install -Dmaven.test.skip=true ，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開發

License Apache License V2