開發restful api總結的幾點小經驗

與其說是開發,不如說是打補丁! spring

是個jesery+spring的restful service,加了一個權限校驗部分,作了一些調整。sql

原本其實很簡單的一個事,後來發現,這個代碼太霸道。原本傳個參數是action_id 這個東西,結果參數名字有以下:action_id,actionID,id 我只能說傻傻分不清楚到底你傳的什麼,api

由於還有其餘id,參數名字參考剛纔的。restful

 

代碼中的也是混亂,雖然我知道有不少先人在修改了,可是也不至於這樣吧。rest

吐槽完畢。code

一、N次開發restful api主意版本迭代,不要在別人的基礎上改,好比此次作,我直接修改!後來就是,從新建了本身的一個version package。遞歸

  這樣作能夠避免以前用老api人的影響,同時能夠本身掌控代碼的質量,至少不用改別人的代碼。別人已經寫好的,你看着不行就改,能夠救直接調用。開發

二、注意代碼的可用性,儘可能不要使用遞歸這種東西,很無腦。除非這個操做很簡單。 此次修改的代碼就是使用 鎖+遞歸 =》作sql查詢,這簡直爆炸了好麼。io

  直接把遞歸這種東西作掉了。基礎

三、多用常量,避免hard code。

四、sql查詢不要使用select * 。 把須要查詢的字段都寫上,這樣作是爲了防止後續schema修改,你的bean不兼容的問題。

五、儘可能把整個api都看懂,由於別人不僅問你你開發的,你還要解決別人留下的那些很傻x的bugs

相關文章
相關標籤/搜索