編碼規範-

-------------------------------------------江西可再生資源大數據平臺項目編碼規範V1.0版本----------------------------------------前端

1. controller包下的全部類以Controller結尾。例如:**Controllerspring

2. dao包下的全部類以Dao結尾。例如:**Daosql

3. service包下的全部類以Service結尾。例如:**Service數據庫

4. service包impl包下的全部類以ServiceImpl結尾。例如:**ServiceImplapi

5. utils包下的全部類以Util結尾。例如:**Util安全

6. entity包下的全部類以Entity結尾。例如:**Entityrestful


7. controller類中方法以及映射的規範:
    聲明:controller中的映射用的url全都採用restful的形式,在url中請勿使用動詞,好比獲取一個id爲1的蘋果手機
        錯誤形式:@GetMapping("/api/getOneIphone")
        正確形式:@GetMapping("/api/iphone/1")mybatis

    (1)查詢接口使用GET方式,若是是分頁,在映射路徑後面加上page,以下例所示
            ***************************************************************************************
                @GetMapping("/資源名稱(名詞)/page")
                    public Object 方法名 (   **Entity entity,
                                            @RequestParam(value="pageNum", defaultValue="1") int pageNum,  
                                            @RequestParam(value="pageSize", defaultValue="10") int pageSize ) {
                    //TODO 分頁方式請參考Mybatis PageHelper 官網
                }
            ***************************************************************************************
    
    (2) 添加操做使用POST方式
            ***************************************************************************************
                @PostMapping("/資源名稱(名詞)/")
                public Object 方法名 (   **Entity entity ) { }
            ***************************************************************************************
    
    (3) 更新操做使用PUT方式
            ***************************************************************************************
                @PutMapping("/資源名稱(名詞)/")
                public Object 方法名 (   **Entity entity ) { }
            ***************************************************************************************
        
8. 全部使用的mapper.xml文件都放置在resources文件夾下的mybatis/mapper文件加下app

9. 請勿隨意添加包或者其餘配置型文件和工具類,如需添加,請先與項目經理確認再添加。iphone


---------------------------------------------------------------------------工程包結構說明-----------------------------------------------
com.jxre.bigdata
    |--common  共同常量類等信息
    |--config  spring相關的配置類
    |--controller 控制層代碼,以頁面菜單爲基礎
    |--service    服務層,與控制層類名對應
    |--service_impl 服務層實現類
    |--dao        數據訪問層,一個dao類對應一個表的訪問操做。sql在對應的mapper.xml中
    |--security   安全相關的類
    |--exception  自定義異常類
    |--utils      公用的工具類
    |--mapper     mybatis的sql語句  
    
    
    mybatis/mapper/*.xml的文件名的前綴還有dao包中類的前綴,還有Entity的前綴相同。
    
----------------------------------------------------------------------關於service中事務和異常的處理方式-------------------------------------
    須要事務回滾,統一貫上拋RuntimeException
    不須要事務回滾的業務異常,統一貫上拋自定義的異常類。而後會有統一的異常攔截器,獲取異常信息,而後將包裝後,將message返回給前臺。好比service中驗證一個變量的合法性,不合法直接拋異對應的異常就行。
    
    
------------------------------------------------------------------------返回值-----------------------------------------------------------
    contorller或者service返回到前端的Map對象中的內容
    {
        "msg" : "返回的信息值,如保存成功",
        "data" :{"success":"true",.....業務各自返回屬性}}
    }
    

------------------------------------------------------------------------Logger規範要求 2018/11/15 add----------------------------------------------------------- 1.異常的catch中不須要寫log。直接向上拋異常便可 2.方法中如傳入的參數,數據庫查出的數據都須要經過log寫到日誌中。 3.業務邏輯處理中好比根據不一樣的條件,執行不一樣的操做室,須要把條件的值寫到     

相關文章
相關標籤/搜索