`CRMEB-Java`遵循`PSR-2`命名規范和`PSR-4`自動加載規范，并且注意如下規范： ### 目錄和文件 * 目錄使用小寫+下劃線；. * 類庫、函數文件統一以`.php`為后綴； * 類的文件名均以命名空間定義，并且命名空間的路徑和類庫文件所在路徑一致； * 類文件采用駝峰法命名（首字母大寫），其它文件采用小寫+下劃線命名； * **類名和類文件名保持一致**，統一采用駝峰法命名（首字母大寫）； ### 函數和類、屬性命名 * 類的命名采用大駝峰法（首字母大寫），例如`User`、`UserType`，默認不需要添加后綴，例如`UserController`應該直接命名為`User`； * 方法命名使用小駝峰法，例如`getClientIp`； * 屬性命名使用小駝峰法，例如`tableName`、`instance`； ### 常量和配置 * 常量以大寫字母和下劃線命名，例如`APP_PATH`； * 配置參數以小寫字母和下劃線命名，例如`url-route-on`和`url-convert`； ### 數據表和字段 * 數據表和字段采用小寫加下劃線方式命名，并注意字段名不要以下劃線開頭，例如`think_user`表和`user_name`字段，不建議使用駝峰和中文作為數據表及字段命名。 ### 系統編碼 UTF-8 LF **請理解并盡量遵循以上命名規范，可以減少在開發過程中出現不必要的錯誤。** # **開發規范** JAVA子項目 遵循阿里巴巴開發規范文檔 # CRMEB Admin ## 開發規范 統一使用ES6 語法 方法注釋 * th => 表頭 * data => 數據 * fileName => 文件名 * fileType => 文件類型 * sheetName => sheet頁名 export default function toExcel ({ th, data, fileName, fileType, sheetName }) 行注釋 // ### 命名 頁面目錄 文件夾命名格式駱駝式命名法,例如：用戶列表 userList 例如：商品模塊 store 商品 ├─ store 商品管理 ├─index.vue 首頁 ├─ creatStore 新建商品 ├─ index.vue ├─ sort 商品分類 ├─ index.vue ├─storeAttr 商品規格 ├─ index.vue ├─storeComment 商品評論 ├─ index.vue 頁面命名、組建、文件夾 命名格式小駝峰命名法,例如：用戶列表 userList 類名函數命名 大駝峰式 例如：addUser 變量命名 小駝峰式 例如：user 或者 userInfo 常量 采用全大些下劃線命名 例如：VUE_APP_API_URl ### 文件管理規范 views 頁面模塊必須件文件夾區分 api 接口一個模塊一個文件 組建 一個組建一個文件夾 plugins 插件一個插件一個文件夾 vuex 路由狀態管理，一個模塊在modules 中建一個文件夾 router 一個模塊一個模塊在modules 中建一個文件夾 style 樣式盡量采用iView自帶組建，common.less 系統通用樣式不要輕易動 自定義通用樣式 style.less,每次添加必須加注釋，頁面獨立樣式在在頁面內寫，后綴less 格式 組建樣式 styles 中添加文件夾 composents 對應components 目錄新建樣式文件 utils 自定義工具js 獨立命名，一般不用新建文件夾 ## 模塊命名 ~~~ ├─ login 登錄 ├─ dashboard 首頁 ├─ store 商品管理 ├─ order 系統訂單管理 ├─ distribution 分銷 ├─ user 用戶管理 ├─ content 內容管理 ├─ appSetting 各個應用模塊功能管理公眾號、小程序、支付寶、百度小程序、今日頭條小程序 ├─ marketing 營銷管理 優惠劵 積分 ├─ sms 設置 短信設置 ├─ systemSetting 設置 管理員權限 系統設置 物流設置 ├─ maintain 維護 配置分類 組合數據 表單配置 ├─ error-page 錯誤頁 ~~~ ## 開發 ```bash # 克隆項目 git clone https://gitee.com/ZhongBangKeJi/crmeb_java/ # 進入項目目錄 cd ## # 安裝依賴 npm install # 建議不要直接使用 cnpm 安裝依賴，會有各種詭異的 bug。可以通過如下操作解決 npm 下載速度慢的問題 npm install --registry=https://registry.npm.taobao.org # 啟動服務 npm run dev ``` 瀏覽器訪問 http://localhost:9527 ## 發布 ```bash # 構建測試環境 npm run build:stage # 構建生產環境 npm run build:prod ``` ## 其它 ```bash # 預覽發布環境效果 npm run preview # 預覽發布環境效果 + 靜態資源分析 npm run preview -- --report # 代碼格式檢查 npm run lint # 代碼格式檢查并自動修復 npm run lint -- --fix ```