【Spring Cloud + Vue 有來商城】研發小組開發規範全方位梳理

時間 2020-10-31

標籤 html 前端 vue java git github sql 數據庫小程序後端欄目 Spring 简体版

原文原文鏈接

項目演示

後端html

管理前端前端

微信小程序vue

vue+uniapp商城實戰 | 第一篇：【有來小店】微信小程序快速開發接入Spring Cloud OAuth2認證中心完成受權登陸

一. 代碼規範

1. Service/DAO 層方法命名規約

1）獲取單個對象的方法用 get 作前綴。java

2）獲取多個對象的方法用 list 作前綴，複數結尾，如：listObjects。git

3）獲取統計值的方法用 count 作前綴。github

4）插入的方法用 save/insert 作前綴。sql

5）刪除的方法用 remove/delete 作前綴。數據庫

2. SQL語句規範

1）SQL 語句中表的別名前加 as，而且以 t一、t二、t三、...的順序依次命名。小程序

select t1.name from table_first as t1, table_second as t2 where t1.id=t2.id;

摘自:後端

Java開發手冊【泰山版】

二. 接口規範

項目接口是基於REST構建的API也就是RESTful架構風格設計。

在RESTful架構中，每一個URL表明一種資源，因此不能有動詞，只能有名詞，並且所用的名詞每每與數據庫的表格名對應。通常來講，數據庫中的表都是同種記錄的"集合"，因此API中的名詞也應該使用複數。

最佳案例

https://youlai.store/users GET 獲取全部用戶信息
https://youlai.store/users/1 GET 獲取標識爲1用戶信息
https://youlai.store/users/1 DELETE 刪除標識爲1用戶信息
https://youlai.store/users/1 Patch 更新標識爲1用戶部分信息,包含在body中
https://youlai.store/users POST 添加新的用戶
https://youlai.store/users/me GET 獲取當前用戶信息

若是記錄數量不少，服務器不可能都將它們返回給用戶。API應該提供參數，過濾返回結果。

?limit=10：指定返回記錄的數量
?offset=10：指定返回記錄的開始位置。
?page=2&per_page=100：指定第幾頁，以及每頁的記錄數。
?sortby=name&order=asc：指定返回結果按照哪一個屬性排序，以及排序順序。
?animal_type_id=1：指定篩選條件

參考:

RESTful API 設計指南

三. Git規範

1. Commit message的格式規範

Commit message 包括三個字段：type（必需）、scope（可選）和subject（必需）。

<type>(<scope>): <subject>

1).type

type用於說明 commit 的類別，規範使用如下標識。

feat：新功能（feature）
fix：修補bug
docs：文檔（documentation）
style：格式（不影響代碼運行的變更）
refactor：重構（即不是新增功能，也不是修改bug的代碼變更）
test：增長測試
chore：構建過程或輔助工具的變更
revert：回滾到上一個版本
merge：代碼合併
sync：同步主線或分支的Bug

2).scope

scope用於說明 commit 影響的範圍，好比數據層、控制層、視圖層等等，視項目不一樣而不一樣。

3). subject

subject是 commit 目的的簡短描述，不超過50個字符。

最佳案例

git commit -m docs(README.md):分支修改項目說明文檔

格式化Commit message的好處

1). 快速預覽歷史

git log <last tag> HEAD --pretty=format:%s

2). 快速過濾查找

git log <last release> HEAD --grep feature

3). commit生成Change log

Change Log 是發佈新版本時，用來講明與上一個版本差別的文。

參考:

Commit message 和 Change log 編寫指南

2. 分支開發主幹發佈模式

禁止在主幹直接修改代碼，需在開發分支開發並在測試環境測試經過以後由相關人員同步到主幹

最佳案例

[master] > git checkout dev

[dev] > git add .
[dev] > git commit -m docs(README.md):分支修改項目說明文檔
[dev] > git push origin dev
[dev] > git checkout master

[master] > git merge dev
[master] > git add .
[master] > git commit -m sync:主幹同步分支
[master] > git push origin master