摘要:源碼鏈接開發(fā)文檔如果你還不是很了解,或者認為只是一種規(guī)范不具有實際意義,推薦一篇兩年前的文章設(shè)計最佳實踐和的一篇極其理論的文章理解本真的架構(gòu)風(fēng)格雖然有點老,介紹的也很簡單,大家權(quán)當了解,的更多好處,還請擁有一樣的的簡潔設(shè)計,使用更簡單的框架
源碼鏈接:Resty 開發(fā)文檔
如果你還不是很了解restful,或者認為restful只是一種規(guī)范不具有實際意義,推薦一篇osc兩年前的文章:RESTful API 設(shè)計最佳實踐 和 Infoq的一篇極其理論的文章 理解本真的REST架構(gòu)風(fēng)格 雖然有點老,介紹的也很簡單,大家權(quán)當了解,restful的更多好處,還請google
擁有jfinal/activejdbc一樣的activerecord的簡潔設(shè)計,使用更簡單的restful框架
restful的api設(shè)計,是作為restful的服務(wù)端最佳選擇(使用場景:客戶端和服務(wù)端解藕,用于對靜態(tài)的html客戶端(mvvm等),ios,andriod等提供服務(wù)端的api接口)
提醒:因框架還在開發(fā)第一個正式項目,所以會有細微調(diào)整,更新提醒頻繁,所以star時關(guān)閉watch,或者您可以在個人設(shè)置->Notification center->Watching->Email 關(guān)閉郵件提醒,感謝您的理解和支持
開發(fā)群:
下載jar包:Resty相關(guān)jar
maven使用方式:
1.添加maven snapshots倉庫
xmloss-snapshots https://oss.sonatype.org/content/repositories/snapshots false true
2.添加依賴包
xml一、獨有優(yōu)點:cn.dreampie resty-route 1.0-SNAPSHOT
重大更新:
Record的時代已經(jīng)到來,你完全不用使用任何的model來執(zhí)行你的數(shù)據(jù)
java//創(chuàng)建record的執(zhí)行器 針對sec_user表 并開啟緩存 Record recordDAO = new Record("sec_user",true); //使用當前數(shù)據(jù)源和表數(shù)據(jù) new一個對象來保存數(shù)據(jù) recordDAO.reNew().set("屬性", "值").save(); Record r1 = recordDAO.reNew().set("屬性", "值"); Record r2 = recordDAO.reNew().set("屬性", "值"); //批量保存 recordDAO.save(r1, r2); //更新 r2.set("屬性", "值").update() //查詢?nèi)?Listrecords = recordDAO.findAll(); //條件查詢 recordDAO.findBy(where,paras) //分頁查詢 Page records = recordDAO.paginateAll(); //根據(jù)id刪除 recordDAO.deleteById("1"); //本次查詢放棄使用cache recordDAO.unCache().findBy(where,paras); //把record的數(shù)據(jù)源切換到dsName數(shù)據(jù)源上 recordDAO.useDS(dsName).findBy(where,paras); //等等,完全擺脫model,實現(xiàn)快速操作數(shù)據(jù)
Model支持動態(tài)切換數(shù)據(jù)源和本次查詢放棄使用cache
javaUser dao=new User(); //本次查詢放棄使用cache dao.unCache().findBy(where,paras); //把model的數(shù)據(jù)源切換到dsName數(shù)據(jù)源上 dao.useDS(dsName).findBy(where,paras);
//數(shù)據(jù)庫和全局參數(shù)配置移植到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 //數(shù)據(jù)庫的配置精簡 自動從文件讀取參數(shù) 只需配置model掃描目錄 和dsName public void configPlugin(PluginLoader pluginLoader) { //第一個數(shù)據(jù)庫 ActiveRecordPlugin activeRecordPlugin = new ActiveRecordPlugin(new DruidDataSourceProvider("default"), true); activeRecordPlugin.addIncludePaths("cn.dreampie.resource"); pluginLoader.add(activeRecordPlugin); }
1.極簡的route設(shè)計,完全融入普通方法的方式,方法參數(shù)就是請求參數(shù),方法返回值就是數(shù)據(jù)返回值
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 }
2.極簡的activerecord設(shè)計,數(shù)據(jù)操作只需短短的一行,支持批量保存對象
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.極簡的客戶端設(shè)計,支持各種請求,文件上傳和文件下載(支持斷點續(xù)傳)
java Client client=null;//創(chuàng)建客戶端對象 //啟動resty-example項目,即可測試客戶端 String apiUrl = "http://localhost:8081/api/v1.0"; //如果不需要 使用賬號登陸 //client = new Client(apiUrl); //如果有賬號權(quán)限限制 需要登陸 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 支持斷點續(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());
4.支持多數(shù)據(jù)源和嵌套事務(wù)(使用場景:需要訪問多個數(shù)據(jù)庫的應(yīng)用,或者作為公司內(nèi)部的數(shù)據(jù)中間件向客戶端提供數(shù)據(jù)訪問api等)
java // 在resource里使用事務(wù),也就是controller里,rest的世界認為所以的請求都表示資源,所以這兒叫resource @GET("/users") @Transaction(name = {"default", "demo"}) //多數(shù)據(jù)源的事務(wù),如果你只有一個數(shù)據(jù)庫 直接@Transaction 不需要參數(shù) public User transaction() { //TODO 用model執(zhí)行數(shù)據(jù)庫的操作 只要有操作拋出異常 兩個數(shù)據(jù)源 都會回滾 雖然不是分布式事務(wù) 也能保證代碼塊的數(shù)據(jù)執(zhí)行安全 } // 如果你需要在service里實現(xiàn)事務(wù),通過java動態(tài)代理(必須使用接口,jdk設(shè)計就是這樣) public interface UserService { @Transaction(name = {"demo"})//service里添加多數(shù)據(jù)源的事務(wù),如果你只有一個數(shù)據(jù)庫 直接@Transaction 不需要參數(shù) public User save(User u); } // 在resource里使用service層的 事務(wù) // @Transaction(name = {"demo"})的注解需要寫在service的接口上 // 注意java的自動代理必須存在接口 // TransactionAspect 是事務(wù)切面 ,你也可以實現(xiàn)自己的切面比如日志的Aspect,實現(xiàn)Aspect接口 // 再private UserService userService = AspectFactory.newInstance(new UserServiceImpl(), new TransactionAspect(),new LogAspect()); private UserService userService = AspectFactory.newInstance(new UserServiceImpl(), new TransactionAspect());
5.極簡的權(quán)限設(shè)計,可以通過cache支持分布式session,你只需要實現(xiàn)一個簡單接口和添加一個攔截器,即可實現(xiàn)基于url的權(quán)限設(shè)計
java public void configInterceptor(InterceptorLoader interceptorLoader) { //權(quán)限攔截器 放在第一位 第一時間判斷 避免執(zhí)行不必要的代碼 interceptorLoader.add(new SecurityInterceptor(new MyAuthenticateService())); } //實現(xiàn)接口 public class MyAuthenticateService implements AuthenticateService { //登陸時 通過name獲取用戶的密碼和權(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)限都放在這兒 你可以通過 文件或者數(shù)據(jù)庫或者直接代碼 來設(shè)置所有權(quán)限 public Set loadAllCredentials() { Set credentials = new HashSet (); credentials.add(new Credential("GET", "/api/v1.0/users**", "users")); return credentials; } }
6.極簡的緩存設(shè)計,可擴展,非常簡單即可啟用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{ public static User dao = new User(); }
7.下載文件,只需要直接return file
java @GET("/files") public File file() { return new File(path); }
8.上傳文件,注解配置把文件寫到服務(wù)器
java @POST("/files") @FILE(dir = "/upload/") //配置上傳文件的相關(guān)信息 public UploadedFile file(UploadedFile file) { return file; }
9.當然也是支持傳統(tǒng)的web開發(fā),你可以自己實現(xiàn)數(shù)據(jù)解析,在config里添加自定義的解析模板
java public void configConstant(ConstantLoader constantLoader) { // 通過后綴來返回不同的數(shù)據(jù)類型 你可以自定義自己的 render 如:FreemarkerRender //默認已添加json和text的支持,只需要把自定義的Render add即可 // constantLoader.addRender("json", new JsonRender()); }二、運行example示例:
1.運行根目錄下的pom.xml->install (命令行: mvn clean install -Dmaven.test.skip=true ,install時跳過測試,因為測試需要連接數(shù)據(jù)庫,沒有數(shù)據(jù)庫會失敗,把相關(guān)的插件安裝到本地,功能完善之后發(fā)布到maven就不需要這樣了)
2.在本地mysql數(shù)據(jù)庫里創(chuàng)建demo,example數(shù)據(jù)庫,對應(yīng)application.properties的數(shù)據(jù)庫配置
3.運行resty-example下的pom.xml->flyway-maven-plugin:migration,自動根具resources下db目錄下的數(shù)據(jù)庫文件生成數(shù)據(jù)庫表結(jié)構(gòu)
4.運行resty-example下的pom.xml->tomcat7-maven-plugin:run,啟動example程序
提醒:推薦idea作為開發(fā)ide,使用分模塊的多module開發(fā)
License Apache License V2
文章版權(quán)歸作者所有,未經(jīng)允許請勿轉(zhuǎn)載,若此文章存在違規(guī)行為,您可以聯(lián)系管理員刪除。
轉(zhuǎn)載請注明本文地址:http://systransis.cn/yun/64193.html
摘要:于是打算做一個擁有非常好用的路由和又非常簡單的框架。但也有一些自己的特色,例如支持自動化緩存自動化讀寫刷新保持與數(shù)據(jù)庫同步,對外使用無感知。例如協(xié)議服務(wù)器地址遠程的類不設(shè)置默認為當前類名其中類在框架里。 背景 在用過laravel框架,發(fā)現(xiàn)它的路由和數(shù)據(jù)庫ORM確實非常好用,但是整體確實有點慢,執(zhí)行到控制器大于需要耗時60ms左右。于是打算做一個擁有非常好用的路由和orm又非常簡單的框...
摘要:菜鳥教程框架中文手冊入門目標使用搭建通過對數(shù)據(jù)增刪查改沒了純粹占行用的拜 后端API入門學(xué)習(xí)指北 了解一下一下概念. RESTful API標準] 所有的API都遵循[RESTful API標準]. 建議大家都簡單了解一下HTTP協(xié)議和RESTful API相關(guān)資料. 阮一峰:理解RESTful架構(gòu) 阮一峰:RESTful API 設(shè)計指南 RESTful API指南 依賴注入 D...
摘要:菜鳥教程框架中文手冊入門目標使用搭建通過對數(shù)據(jù)增刪查改沒了純粹占行用的拜 后端API入門學(xué)習(xí)指北 了解一下一下概念. RESTful API標準] 所有的API都遵循[RESTful API標準]. 建議大家都簡單了解一下HTTP協(xié)議和RESTful API相關(guān)資料. 阮一峰:理解RESTful架構(gòu) 阮一峰:RESTful API 設(shè)計指南 RESTful API指南 依賴注入 D...
摘要:菜鳥教程框架中文手冊入門目標使用搭建通過對數(shù)據(jù)增刪查改沒了純粹占行用的拜 后端API入門學(xué)習(xí)指北 了解一下一下概念. RESTful API標準] 所有的API都遵循[RESTful API標準]. 建議大家都簡單了解一下HTTP協(xié)議和RESTful API相關(guān)資料. 阮一峰:理解RESTful架構(gòu) 阮一峰:RESTful API 設(shè)計指南 RESTful API指南 依賴注入 D...
摘要:歡迎感興趣的去了解和提出建議,也歡迎地址期望用法先來看看我要怎么用這個框架基本上跟類似,先一個對象,使用方法添加中間件,支持閉包或外部文件。 nodejs的koa可以說是非常受歡迎的,特別是其洋蔥模型應(yīng)該用過的人印象都比較深,下面就嘗試用php來實現(xiàn)一個。 注:本文是PHPec框架的最原始思路版本。PHPec是在此基礎(chǔ)上完善編寫出來的一個極簡的輕量級開發(fā)框架,除了提供中間件調(diào)用模式外,...
閱讀 2322·2021-11-24 09:39
閱讀 3055·2021-10-15 09:39
閱讀 3106·2021-07-26 23:38
閱讀 2301·2019-08-30 11:14
閱讀 3420·2019-08-29 16:39
閱讀 1723·2019-08-29 15:23
閱讀 791·2019-08-29 13:01
閱讀 2673·2019-08-29 12:29