coding-standards.mdc 7.5 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419
  1. ---
  2. alwaysApply: false
  3. ---
  4. ### 编码规范
  5. #### 命名规范
  6. **文件命名**
  7. - 页面文件:使用 kebab-case,如 `order-list.vue`
  8. - 组件文件:使用 PascalCase,如 `UserCard.vue`
  9. - 工具文件:使用 camelCase,如 `dateUtils.js`
  10. **变量命名**
  11. - 常量:使用 SCREAMING_SNAKE_CASE,如 `API_BASE_URL`
  12. - 变量和函数:使用 camelCase,如 `getUserInfo`
  13. - 组件 props:使用 camelCase,如 `itemList`
  14. - CSS 类名:使用 kebab-case,如 `.user-card`
  15. #### 组件开发规范
  16. **单文件组件结构顺序**
  17. ```vue
  18. <template>
  19. <!-- 模板内容 -->
  20. </template>
  21. <script> // 或 <script setup lang="ts">
  22. export default {
  23. // 组件选项
  24. }
  25. </script>
  26. <style lang="scss" scoped>
  27. /* 样式内容 */
  28. </style>
  29. ```
  30. **Props 定义**
  31. ```javascript
  32. // Vue 2 Options API
  33. props: {
  34. title: {
  35. type: String,
  36. required: true,
  37. default: ''
  38. },
  39. list: {
  40. type: Array,
  41. default: () => []
  42. }
  43. }
  44. ```
  45. #### API 请求规范
  46. **统一请求处理**
  47. ```javascript
  48. // 使用 uni.request 而不是 axios
  49. const request = (options) => {
  50. return new Promise((resolve, reject) => {
  51. uni.request({
  52. url: options.url,
  53. method: options.method || 'GET',
  54. data: options.data || {},
  55. header: {
  56. 'Content-Type': 'application/json',
  57. ...options.header
  58. },
  59. success: (res) => {
  60. if (res.statusCode === 200) {
  61. resolve(res.data)
  62. } else {
  63. reject(res)
  64. }
  65. },
  66. fail: reject
  67. })
  68. })
  69. }
  70. ```
  71. **错误处理**
  72. ```javascript
  73. try {
  74. const result = await apiCall()
  75. // 处理成功结果
  76. } catch (error) {
  77. uni.showToast({
  78. title: error.message || '请求失败',
  79. icon: 'none'
  80. })
  81. }
  82. ```
  83. #### 状态管理规范
  84. **Store 结构**
  85. ```javascript
  86. // Vuex 或 Pinia
  87. const store = {
  88. state: {
  89. user: null,
  90. loading: false
  91. },
  92. mutations: {
  93. SET_USER(state, user) {
  94. state.user = user
  95. },
  96. SET_LOADING(state, loading) {
  97. state.loading = loading
  98. }
  99. },
  100. actions: {
  101. async login({ commit }, params) {
  102. commit('SET_LOADING', true)
  103. try {
  104. const user = await loginApi(params)
  105. commit('SET_USER', user)
  106. } finally {
  107. commit('SET_LOADING', false)
  108. }
  109. }
  110. }
  111. }
  112. ```
  113. #### 样式规范
  114. **使用 rpx 单位**
  115. ```scss
  116. .container {
  117. padding: 32rpx; // 推荐
  118. margin: 16rpx 24rpx; // 推荐
  119. font-size: 28rpx; // 推荐
  120. // 避免使用 px,除非是特殊需求
  121. border: 1px solid #ccc; // 细边框可以使用 px
  122. }
  123. ```
  124. **响应式设计**
  125. ```scss
  126. .grid {
  127. display: flex;
  128. flex-wrap: wrap;
  129. .item {
  130. width: 50%;
  131. // 条件编译样式
  132. /* #ifdef H5 */
  133. &:hover {
  134. background-color: #f5f5f5;
  135. }
  136. /* #endif */
  137. }
  138. }
  139. ```
  140. #### 性能优化规范
  141. **列表渲染优化**
  142. ```vue
  143. <template>
  144. <!-- 使用 key 提升渲染性能 -->
  145. <view v-for="item in list" :key="item.id">
  146. {{ item.name }}
  147. </view>
  148. <!-- 长列表使用虚拟滚动 -->
  149. <recycle-list :list="longList" :item-height="100">
  150. <template v-slot="{ item }">
  151. <ListItem :data="item" />
  152. </template>
  153. </recycle-list>
  154. </template>
  155. ```
  156. **图片优化**
  157. ```vue
  158. <template>
  159. <!-- 使用 lazy-load 懒加载 -->
  160. <image
  161. :src="imageUrl"
  162. mode="aspectFill"
  163. lazy-load
  164. @error="handleImageError"
  165. />
  166. </template>
  167. ```
  168. #### 调试和测试
  169. **调试信息**
  170. ```javascript
  171. // 条件编译调试代码
  172. // #ifdef APP-PLUS || H5
  173. console.log('Debug info:', data)
  174. // #endif
  175. // 使用 uni.getSystemInfo 获取设备信息
  176. uni.getSystemInfo({
  177. success: (res) => {
  178. console.log('Platform:', res.platform)
  179. console.log('Version:', res.version)
  180. }
  181. })
  182. ```
  183. **错误监控**
  184. ```javascript
  185. // App.vue 中的全局错误处理
  186. onError(err => {
  187. console.error('Global error:', err)
  188. // 上报错误到监控平台
  189. })
  190. ```
  191. ### 编码规范
  192. #### 命名规范
  193. **文件命名**
  194. - 页面文件:使用 kebab-case,如 `order-list.vue`
  195. - 组件文件:使用 PascalCase,如 `UserCard.vue`
  196. - 工具文件:使用 camelCase,如 `dateUtils.js`
  197. **变量命名**
  198. - 常量:使用 SCREAMING_SNAKE_CASE,如 `API_BASE_URL`
  199. - 变量和函数:使用 camelCase,如 `getUserInfo`
  200. - 组件 props:使用 camelCase,如 `itemList`
  201. - CSS 类名:使用 kebab-case,如 `.user-card`
  202. #### 组件开发规范
  203. **单文件组件结构顺序**
  204. ```vue
  205. <template>
  206. <!-- 模板内容 -->
  207. </template>
  208. <script>
  209. // 或 <script setup lang="ts">
  210. export default {
  211. // 组件选项
  212. }
  213. </script>
  214. <style lang="scss" scoped>
  215. /* 样式内容 */
  216. </style>
  217. ```
  218. **Props 定义**
  219. ```javascript
  220. // Vue 2 Options API
  221. props: {
  222. title: {
  223. type: String,
  224. required: true,
  225. default: ''
  226. },
  227. list: {
  228. type: Array,
  229. default: () => []
  230. }
  231. }
  232. ```
  233. #### API 请求规范
  234. **统一请求处理**
  235. ```javascript
  236. // 使用 uni.request 而不是 axios
  237. const request = (options) => {
  238. return new Promise((resolve, reject) => {
  239. uni.request({
  240. url: options.url,
  241. method: options.method || 'GET',
  242. data: options.data || {},
  243. header: {
  244. 'Content-Type': 'application/json',
  245. ...options.header
  246. },
  247. success: (res) => {
  248. if (res.statusCode === 200) {
  249. resolve(res.data)
  250. } else {
  251. reject(res)
  252. }
  253. },
  254. fail: reject
  255. })
  256. })
  257. }
  258. ```
  259. **错误处理**
  260. ```javascript
  261. try {
  262. const result = await apiCall()
  263. // 处理成功结果
  264. } catch (error) {
  265. uni.showToast({
  266. title: error.message || '请求失败',
  267. icon: 'none'
  268. })
  269. }
  270. ```
  271. #### 状态管理规范
  272. **Store 结构**
  273. ```javascript
  274. // Vuex 或 Pinia
  275. const store = {
  276. state: {
  277. user: null,
  278. loading: false
  279. },
  280. mutations: {
  281. SET_USER(state, user) {
  282. state.user = user
  283. },
  284. SET_LOADING(state, loading) {
  285. state.loading = loading
  286. }
  287. },
  288. actions: {
  289. async login({ commit }, params) {
  290. commit('SET_LOADING', true)
  291. try {
  292. const user = await loginApi(params)
  293. commit('SET_USER', user)
  294. } finally {
  295. commit('SET_LOADING', false)
  296. }
  297. }
  298. }
  299. }
  300. ```
  301. #### 样式规范
  302. **使用 rpx 单位**
  303. ```scss
  304. .container {
  305. padding: 32rpx; // 推荐
  306. margin: 16rpx 24rpx; // 推荐
  307. font-size: 28rpx; // 推荐
  308. // 避免使用 px,除非是特殊需求
  309. border: 1px solid #ccc; // 细边框可以使用 px
  310. }
  311. ```
  312. **响应式设计**
  313. ```scss
  314. .grid {
  315. display: flex;
  316. flex-wrap: wrap;
  317. .item {
  318. width: 50%;
  319. // 条件编译样式
  320. /* #ifdef H5 */
  321. &:hover {
  322. background-color: #f5f5f5;
  323. }
  324. /* #endif */
  325. }
  326. }
  327. ```
  328. #### 性能优化规范
  329. **列表渲染优化**
  330. ```vue
  331. <template>
  332. <!-- 使用 key 提升渲染性能 -->
  333. <view v-for="item in list" :key="item.id">
  334. {{ item.name }}
  335. </view>
  336. <!-- 长列表使用虚拟滚动 -->
  337. <recycle-list :list="longList" :item-height="100">
  338. <template v-slot="{ item }">
  339. <ListItem :data="item" />
  340. </template>
  341. </recycle-list>
  342. </template>
  343. ```
  344. **图片优化**
  345. ```vue
  346. <template>
  347. <!-- 使用 lazy-load 懒加载 -->
  348. <image
  349. :src="imageUrl"
  350. mode="aspectFill"
  351. lazy-load
  352. @error="handleImageError"
  353. />
  354. </template>
  355. ```
  356. #### 调试和测试
  357. **调试信息**
  358. ```javascript
  359. // 条件编译调试代码
  360. // #ifdef APP-PLUS || H5
  361. console.log('Debug info:', data)
  362. // #endif
  363. // 使用 uni.getSystemInfo 获取设备信息
  364. uni.getSystemInfo({
  365. success: (res) => {
  366. console.log('Platform:', res.platform)
  367. console.log('Version:', res.version)
  368. }
  369. })
  370. ```
  371. **错误监控**
  372. ```javascript
  373. // App.vue 中的全局错误处理
  374. onError(err => {
  375. console.error('Global error:', err)
  376. // 上报错误到监控平台
  377. })
  378. ```