您好,欢迎来到微智科技网。
搜索
您的当前位置:首页小程序的项目结构设计

小程序的项目结构设计

来源:微智科技网

简要认识小程序开发

其中小程序的构成是由.wxml.wxss.js.json四种类型构成(下文将简称为四类文件)。其开发方式跟传统网页开发是十分类似的。

  • .wxml模板文件对应为传统网页开发的.html文件,是一个页面(组件)的骨架。只不过它里面采用的语法跟传统的HTML语法有些差异, 比如标签的名称是微信自己在底层封装的组件。
  • .wxss样式文件则对应CSS样式文件,具有大部分CSS的特性(比如css3的某些伪类特性就没有,但常见的css3属性倒是可以用),除此之外还在此基础上做了新的扩展。
  • js一直都是作为跟页面交互角色,在小程序开发中也不例外。
    js中,可以使用微信提供的API。如常见的Page(构造器)和Component,还有微信给出的一些特定权限的API.
  • json则是配置文件,一般是页面或者组件内那一级的配置文件。

(这里有个小细节可以区分wxmlwxss区别,这两者都是以wx(微信)为开头,后面的小尾巴是区别是样式文件还是模板文件)。

具体的更多细节可以去看。本文的重心还是在讨论项目结构如何安排会比较整洁合理。

项目结构设计思路

  • app.js 需要在里面调用App()函数,注册一个小程序。
  • app.json 小程序进行全局配置,决定页面文件的路径、窗口表现、设置网络超时时间、设置多 tab 等。
  • app.wxss 全局样式,作用于每一个页面。但注意的是app.wxss写的全局样式不会影响组件内的样式。
├── app.js
├── app.json
├── app.wxss
└── project.config.json

页面

├── pages
│   │── home
│   │   ├── home.wxml
│   │   ├── home.js
│   │   ├── home.json
│   │   └── home.wxss
│   └── user
│       ├── user.wxml
│       └── user.js
├── ...
└── project.config.json

这时可以考虑换一种方式储存,在页面文件夹里再加一个文件夹, 名为subpage。把子页放在这个文件夹内,这样层级关系就清晰了,缺点就是不适合套太深。或者说一个产品也不应该把页面藏得太深让用户找不到...

├── pages
│   └── home
│       ├── subpage
│       │   └── detail
│       │       ├── index.wxml
│       │       └── ...
│       ├── home.wxml
│       └── ...
├── ...
└── project.config.json

至于项目简单一些的话前者会好一点(子页命名参照master-description的格式),页面太过复杂的话可能会比较推荐使用后者的方式。

图片

├── iamges (公共图片)
│   │── icon
│   │   ├── icon@download.png
│   │   └── icon@cancel.png
|   └── ...
├── pages
│   └── index
│       ├── images
│       |   └── index@bg.png
│       |   └── index@video.png
│       ├── index.wxml
│       ├── index.js
│       ├── index.json
│       └── index.wxss
├── ...
└── project.config.json
<!-- 绝对路径 -->
<images src="/images/icon@download.png" />

<!-- 相对路径 -->
<images src="./images/index@video.png" />
// 会报错
import iconDownload from '/images/icon@download.png'
// 只能使用相对路径
import iconDownload from '/../../icon@download.png'

样式

写完页面后自然需要给页面润色, 我们可以通过在页面的.wxss来写局部样式,这没问题。但在我们完成一个又一个页面后,这时你可能会发现有些页面的样式重复性太高了。

因为一个成熟的设计师,在设计每一个产品时,大多会有一套设计风格或者称之为主题的东西。这些元素大量重复在各个页面中,我们重复写这些样式实际上代码是有点冗余的。

{% asset_img button.png 主题按钮 %}

├── style
│   ├── button.wxss
│   └── ...
├── ...
└── project.config.json

直接在.wxss的顶层引入即可复用。

@improt '/style/button.wxss';

/* other code */

至于是为何不在app.json中设定全局样式而单独抽出来的原因也是前文所提及的问题————组件中默认情况下不受全局样式影响的,理论上组件也不该受到外部样式的”无意“的影响。
app.json中的样式只需要加载一次就全局可用,外部样式就不一定了(因为没有实际的调研过),而且还需要额外的去做引入的那一步。具体用哪一种方式还是要看具体情况来自己斟酌啦~

还有一些方法,比如使用scssless之类的预处理之类的方案,也是可以,只不过超出了本文的讨论范围,不展开讲。

组件

组件对于熟悉模块化开发的同学自然不陌生,小程序基础库版本 1.6.3 就开始支持自定义组件了,至今为止也不用担心兼容性的问题了。从笔者角度来看看法,小程序的组件可以分为全局组件和局部组件。

全局性是指那种封装了登录、弹框、动画组件等等之类的组件,局部的大多是减轻一个页面内的复杂度,通过模块"搭积木"的方式来组成一个页面。即使某个功能砍了也能对页面减少牵连。

组件下的四类文件按照componment/index的方式命名与page区分。

├── componments (公共组件)
│   │── anima
│   │   ├── coin
│   |   |   ├── index.js
│   |   |   └── ...
│   │   └── liquid
│   |       └── ...
|   └── ...
├── pages
│   └── home
│       ├── componments
│       |   └── goods
│       |     ├── index.wxml
│       |     └── ...
│       ├── home.wxml
│       ├── home.js
│       ├── home.json
│       └── home.wxss
├── ...
└── project.config.json

utils

├── utils (工具集)
│   │── api
│   │   └── ...
|   ├── ... (其他工具类)
|   ├── config.js
|   └── local.config.js (本地配置,git忽略)
├── ...
└── project.config.json

分包

├── app.js
├── app.json
├── app.wxss
├── packageA
│   └── pages
│       ├── cat
│       └── dog
├── packageB
│   └── pages
│       ├── apple
│       └── banana
├── pages
│   ├── index
│   └── user
└── utils
├── subpackages (分包)
│   │── news
│   │   └── ...
|   └── store
│       └── ...
├── ...
└── project.config.json

结束

最后的一个小程序项目主体结构大致是:

├── components (公共组件目录)
│   ├── @anima (动画组件)
│   └── ...
├── images(公共图片)
│   └── icon
│      ├── icon@download.png
│      └── icon@cancel.png
├── pages(主包目录)
│   └── home (app.json 设置的入口页)
│       ├── home.wxml
│       ├── home.js
│       ├── home.json
│       └── home.wxss
├── style(公用样式目录)
├── subpackages(分包目录)
│   │── news
|   └── store
├── utils(公共模块,工具类)
│   ├── config.js(项目配置)
│   └── local.config.js (本地配置,git忽略)
├── .editorconfig
├── .gitignore
├── app.js
├── app.json
├── app.wxss
├── project.config.json
└── README.md

以上是从原生小程序开发的角度来对项目结构的设计进行一个思路总结,没有过多的讲更深入的东西。下一期想整理一下关于API封装和管理,欢迎指导~

因篇幅问题不能全部显示,请点此查看更多更全内容

Copyright © 2019- 7swz.com 版权所有 赣ICP备2024042798号-8

违法及侵权请联系:TEL:199 18 7713 E-MAIL:2724546146@qq.com

本站由北京市万商天勤律师事务所王兴未律师提供法律服务