Skip to content

一、工程目标(先定设计原则)

这套模板的目标是:

  • 页面薄、逻辑集中
  • 可测试、可扩展
  • 避免 setData 性能坑
  • 符合微信审核 & 规范
  • 不依赖重型框架(原生 + 轻封装)

适合:原生小程序 / Taro / uni-app 思维都能套

二、推荐目录结构(核心)

miniprogram/
├─ app.js
├─ app.json
├─ app.wxss

├─ pages/                    # 页面(只放 Page 壳)
│  ├─ home/
│  │  ├─ index.js
│  │  ├─ index.wxml
│  │  ├─ index.wxss
│  │  └─ index.logic.js      # 页面业务逻辑
│  └─ detail/

├─ components/               # 通用组件
│  ├─ Base/
│  │  ├─ Button/
│  │  ├─ Modal/
│  └─ Business/              # 业务组件
│     └─ ProductCard/

├─ services/                 # 所有接口层
│  ├─ request.js             # 请求封装
│  ├─ auth.js                # 登录 / token
│  ├─ user.api.js
│  └─ order.api.js

├─ store/                    # 全局状态
│  ├─ index.js
│  └─ user.store.js

├─ utils/                    # 工具函数
│  ├─ logger.js
│  ├─ debounce.js
│  ├─ validate.js
│  └─ env.js

├─ config/                   # 配置
│  ├─ index.js
│  ├─ api.config.js
│  └─ permission.config.js

├─ constants/                # 常量
│  ├─ error-code.js
│  └─ storage-key.js

├─ styles/                   # 全局样式
│  ├─ variables.wxss
│  └─ mixin.wxss

└─ subpackages/              # 分包
   └─ profile/

三、页面“瘦身”模式(非常重要)

❌ 错误做法

js
Page({
  data: {},
  onLoad() {
    wx.request(...)
  },
  onTap() {
    // 一堆业务逻辑
  }
})

✅ 正确做法:Page + Logic 分离

pages/home/index.js
js
import logic from './index.logic'

Page({
  ...logic
})
pages/home/index.logic.js
js
import { getHomeData } from '../../services/home.api'

export default {
  data: {
    list: []
  },

  async onLoad() {
    const data = await getHomeData()
    this.setData({ list: data })
  },

  onItemTap(e) {
    const id = e.currentTarget.dataset.id
    wx.navigateTo({ url: `/pages/detail/index?id=${id}` })
  }
}

👉 好处:

  • 页面只是「壳」
  • 逻辑可测试
  • 后期可迁移到 Taro / React

四、请求层设计(最关键)

1️⃣ request 封装

services/request.js

js
import { getToken } from './auth'

const BASE_URL = 'https://api.xxx.com'

export function request(options) {
  return new Promise((resolve, reject) => {
    wx.request({
      url: BASE_URL + options.url,
      method: options.method || 'GET',
      data: options.data || {},
      header: {
        Authorization: getToken()
      },
      success(res) {
        if (res.statusCode === 200) {
          resolve(res.data)
        } else {
          reject(res)
        }
      },
      fail(err) {
        reject(err)
      }
    })
  })
}

2️⃣ API 分模块

services/user.api.js

js
import { request } from './request'

export function getUserInfo() {
  return request({
    url: '/user/info'
  })
}

👉 禁止在 Page 里写 wx.request

五、全局状态管理(轻量)

store/index.js

js
const store = {
  user: null,
  setUser(user) {
    this.user = user
  }
}

export default store

使用

js
import store from '../../store'

store.setUser(res)

👉 小程序不适合 Redux 重方案 👉 “能不用全局就不用”

六、setData 性能规范(必须写进团队规范)

❌ 禁止

js
this.setData({ bigList })
this.setData({ count })

✅ 推荐

js
this.setData({
  'bigList[3].title': 'xxx'
})

约定

  • setData ≤ 1 次 / 事件
  • 大对象拆字段
  • 列表分页加载

七、组件设计规范

组件结构

ProductCard/
├─ index.js
├─ index.wxml
├─ index.wxss
└─ index.json

组件通信

  • 父 → 子:properties
  • 子 → 父:triggerEvent
  • ❌ 不直接操作父 data

八、配置 & 环境隔离

config/env.js

js
export const ENV = 'prod'

config/api.config.js

js
export const API_HOST = {
  dev: 'https://dev.api.com',
  prod: 'https://api.com'
}

九、分包设计(上线前必做)

json
{
  "subpackages": [
    {
      "root": "subpackages/profile",
      "pages": ["index"]
    }
  ]
}

👉 主包 ≤ 2MB 👉 非首屏页面全进分包

十、你可以直接复用的 Checklist

  • ✅ 页面 + logic 分离
  • ✅ API 层集中
  • ✅ 禁止业务代码进 Page
  • ✅ 分包
  • ✅ setData 规范
  • ✅ 权限延迟申请