753.【平台开发】技术整合思考（六）开发规范（持续更新）

这个开发规范，完全出于七镜平时的工作经验，方便七镜平台发使用，可能与业内广泛流传的开发规范有悖！

一、服务端

A、命名规范

1. 加s表示单词复数，不遵循英语语法规范，诸如不规则变换的复数表示形式统统不用考虑。

B、接口规范

1. 接口返回结构体中，第1级包含code、content、count、msg4个字段。其中code表示状态码，content表示实际返回的数据，必须是以序列（数组）形式返回，count表示实际返回的数据的条数，msg表示服务端消息或描述。第2级msg，包含成功消息success和失败消息fail。

type ResponseCommon struct {
    //common response body struct
    Code    int         `json:"code"`
    Content interface{} `json:"content"`
    Count   int64       `json:"count"`
    Msg     Message     `json:"msg"`
}

type Message struct {
    Success string `json:"success"`
    Fail    string `json:"fail"`
}

2. 查询接口不区分详情数据和列表数据，即实际返回数据永远是序列（数组），详情数据就是数组长度为1的特殊情况。

二、客户端

1. 导入图片时，图片变量命名规范为【图片格式_实际意义】，比如：

import PNG_DEFAULT from "./image/default.png"
import JPG_WX from './image/wx.jpg'

2. [2023-08-07更新]每一个实体对应两种展示页面，其一是详情页，其二是列表页（一般列表页作为详情页的入口）。实体详情页面命名为【实体】，实体列表页面命名为【实体-list】比如：

// 产品下载详情页
production-download 
// 新闻详情页
news
// 产品下载列表页
production-download-list
// 新闻列表页
news-list