10

项目开始前,我们先聊一聊关于项目的一些说明。该项目起始于2017年初,当时公司主要技术栈为gulp+angular,鉴于react的火热的生态,在公司决定研发bss管理系统时选用react开发,目的也是为react native打下基础,以解决后期公司大前端技术栈的逐步成熟。(当时没有选择vue开发的主要原因是weex生态还不够特别成熟),既然决定换新,项目的构建也跟着一起换,从gulp转向火热的webpack,持续大半年的更新迭代,我们将构建模块逐步从项目中抽离出来,把构建模块作为npm包单独管理,完成和项目代码解耦,于是就有了后面我们要说的wci-build构建模块包和wci-cli项目脚手架。

我们要做什么

技术栈

项目采用前后端分离的形式,后端选用Maven+SpringClould全家桶开发,前端选用webpack+react全家桶开发,前后端全部采用包管理工具完全解决项目依赖管理的难题,版本管理采用git,前后端通过json交互,swgger管理接口文档,接口全部遵循restful规范。由于本文面向社区开放,故本文中不涉及公司业务层的代码,本文全部代码均为最新编写,我们以一个旅游管理系统的三个模块为大家演示项目(登陆登出、用户模块、景点模块)。为了快速开展,本文涉及的后端代码直接采用Java的SSM框架搭建,源码也将为大家奉上。朋友们也可以使用mock模拟接口数据。后期我们在演示nodejs+espress时将接口代码全部转为node形式。

准备

因本文不是讲解基础,故大家在敲代码前,还需要具备一定的前端基础,部分如下

  1. html、css、javascript基础知识
  2. es6基础知识
  3. react基础知识
  4. 了解什么是webpack、babel、redux、react-router、nodejs、npm
  5. 熟悉蚂蚁金服ant design
  6. 熟悉less基本使用

解决什么问题

本项目集成了最新的react16、react-router4、redux,同时可以选择性集成antd|antd mobile,在解决繁琐的架构配置工作外,还解决了以下问题

通用问题
  1. 支持开发效率更高的ES6编写代码。
  2. 拆分开发、测试、生产环境,完成从开发到上线的所有工作。
  3. 开发环境包含热替换,本地IP、端口可配置,接口可配置,微服务模块可配置
  4. 测试环境包含代码压缩、合并、css抽离、公共组件抽离、代码添加hash、测试版本后缀
  5. 生产环境包含代码压缩、合并、css抽离、公共组件抽离、代码添加hash、生产版本后缀(和测试代码完全一样,只缺少测试版本号)
  6. 支持自定义添加webpack loader
其他问题
  1. 目前大型项目后端多采用微服务架构,API接口在开发、测试、生产环境下来回切换,需要频繁修改代码。解决方案:通过配置文件的方式统一配置项目模块接口
  2. 项目模块在分拆开发的过程中css命名冲突,导致代码维护性较差。解决方案:构建工具预加载css时自动化添加hash,使css代码模块化
  3. 不同开发人员,不同的代码习惯造成项目代码难以维护。解决方案:在代码编写、构建、版本管理三个方向加入代码规范校验(airbnb规范)
  4. 在同时开发多个系统的时候,构建业务模块在不同的项目都存在,当需要修改配置或者优化构建方案的时候,需要修改多个项目的配置。解决方案:抽离构建模块,采用npm形式依赖。

还有什么问题要解决

虽然经过大半年迭代,但我们还需要在实际项目开发中支持更多的个性化需求

  1. cdn自动化
  2. 更加完善的持续集成
  3. 单元测试,包括代码,交互测试
  4. mock数据,实现前后端真正0接触
  5. ...

希望

大家在开发过程中遇到任何问题,希望可以给我们留言,我们会不断优化项目。未来,我们还会加入mobx、rxjs、immutablejs、GraphQL等,也希望在和大家的探讨中,持续进步。

项目准备

本项目基础环境必须依赖nodejsnpm,未安装的朋友可以去官网自行安装,安装教程这里不详细说明,安装完成后使用如下命令,查看是否安装成功。

node -v
npm -v

初始化项目

本项目我们使用wci-cli脚手架初始化项目

  • 全局安装wci-cli
npm install -g wci-cli
  • 创建项目

wci-cli 脚手架可以创建三种项目,分别是1.纯净的react项目 2.包含antd的react项目 3.包含antd-mobile的react项目,命令如下

wci new myapp

执行命令后,命令行会提示是否需要安装antd以及选择antd类型,即可完成项目初始化,如下

项目目录

myapp
├── app // 项目业务代码
│   ├── assets // 静态文件目录(图片、字体等)
│   ├── script // js代码目录
│   │   ├── actions // redux action目录
│   │   ├── componets // react 无状态组件目录
│   │   ├── containers // react 业务代码
│   │   ├── reducers // redux reducer目录
│   │   ├── util // 工具包目录
│   │   │   ├── theme.js // antd自定义样式文件
│   │   ├── Home.js // 首页
│   │   ├── home.less // 首页样式
│   ├── styles // 全局样式目录
│   ├── index.js // 项目入口文件
│   ├── index.tpl.html // 项目html模版
├── node_modules // 依赖包目录
├── .babelrc // babel配置文件
├── .eslintrc // eslint代码校验配置文件
├── .gitignore
├── package.json
├── README.md
├── wci.json // wci项目配置文件(主要配置一些开发、测试、生产环境的信息)
└── webpack.js // webpack自定义配置文件

执行如下命令,运行开发环境

cd myapp
npm run start

如上图,我们的项目已经跑起来了...

  • 测试、发布

因我们需要保证测试代码和生产代码必须保持一致,所有在实际项目中,我们可以运行如下命令构建代码

npm run test // 测试环境打包
npm run dist // 生产环境打包

测试代码

生产代码

到这里,我们已经完成项目前期开发的所有准备工作,接下来,我们一起开始撸代码吧

项目结束后,我会为大家奉上两篇彩蛋,分别是 1. 一步步搭建webpack前端构建工具并抽成npm单独模块 2. 一步步构建自己的npm开发包并且以一个真实例子演示(开发一个命令行生成文件夹结构的小工具)

还要说一点

正式开始撸代码前,还要针对项目具体说明,包括项目代码目录介绍,前后端分离项目需要注意哪些问题,前后端如何鉴权等...

都是干什么的

myapp
├── app // 项目业务代码
│   ├── assets // 静态文件目录(图片、字体等)
│   ├── script // js代码目录
│   │   ├── actions // redux action目录
│   │   ├── componets // react 无状态组件目录
│   │   ├── containers // react 业务代码
│   │   ├── reducers // redux reducer目录
│   │   ├── util // 工具包目录
│   │   │   ├── theme.js // antd自定义样式文件
│   │   ├── Home.js // 首页
│   │   ├── home.less // 首页样式
│   ├── styles // 全局样式目录
│   ├── index.js // 项目入口文件
│   ├── index.tpl.html // 项目html模版
├── node_modules // 依赖包目录
├── .babelrc // babel配置文件
├── .eslintrc // eslint代码校验配置文件
├── .gitignore
├── package.json
├── README.md
├── wci.json // wci项目配置文件(主要配置一些开发、测试、生产环境的信息)
└── webpack.js // webpack自定义配置文件

以上是代码的全部目录,下面我们根据功能依次介绍:

  • node_modules、.gitignore、package.json、README.md
node_modules: npm依赖包目录,开发者可以不用管,只要知道我们项目里所有的依赖都下载在这个文件夹下
.gitignore:git需要忽略的文件
package.json:npm最主要的文件,里面写满了我们依赖包的结构和一些项目信息
README.md:github的说明文件
  • .babelrc、.eslintrc
.babelrc:babel配置文件,可以配置部分自定义babel插件(例如本项目里antd自定义主题和javascript@语法糖就在这里配置)
.eslintrc:eslint配置文件,可以自定义配置eslint规则,详细规则可以去官网eslint查看

说明:这两个模块本该配置在wci-build构建工具里,但考虑到项目的灵活性,所有抽离出来放在项目根目录

  • webpack.js
webpack.js:webpack loader个性化的配置文件,可以自定义添加webpack loader
  • wci.json
wci.json:项目的配置文件,可以自定义配置项目
{
  "index": "app/index.js", // 项目入口文件
  "hostname": "127.0.0.1", // 开发环境IP地址(可以配置域名通过本地host转发)
  "name": "wci-antd-app", // 项目名称(显示在浏览器title里的名字)
  "libs": [ // 项目的公共包,后续可以自行添加
    "react",
    "react-dom",
    "axios",
    "classnames",
    "prop-types",
    "react-redux",
    "react-router-dom",
    "redux",
    "redux-thunk"
  ],
  "dev": { // 开发环境配置
    "port": 8031, // 开发环境端口
    "src": "app", // 开发环境监听目录
    "api": "", // 开发环境后端接口地址
    "module": {}, // 开发环境的模块包
    "is_eslint": false // 开发环境是否开启eslint校验
  },
  "test": { // 测试环境配置
    "module": {}, // 测试环境的模块包
    "api": "" // 测试环境后端接口地址
  },
  "prod": { // 生产环境配置
    "module": {}, // 生产环境的模块包
    "api": "" // 生产环境后端接口地址
  }
}
  • app
项目目录
├── app // 项目业务代码
│   ├── assets // 静态文件目录(图片、字体等)
│   ├── script // js代码目录
│   │   ├── actions // redux action目录
│   │   ├── componets // react 无状态组件目录
│   │   ├── containers // react 业务代码
│   │   ├── reducers // redux reducer目录
│   │   ├── util // 工具包目录
│   │   │   ├── theme.js // antd自定义样式文件
│   │   ├── Home.js // 首页
│   │   ├── home.less // 首页样式
│   ├── styles // 全局样式目录
│   ├── index.js // 项目入口文件
│   ├── index.tpl.html // 项目html模版

如上,因为react遵循组件化开发,故我们的业务代码全部写在containers目录下,并且模块的样式文件、高阶组件写在相对的模块下,如图

styles目录用于存放项目全局的样式文件,例如全局样式的变量文件等...

其他

版本管理:

推荐使用gitflow来进行版本的管理,这里不做详细描述

前后端分离跨域:

一旦项目采用前后端分离,跨域是所有项目里不可避免的问题,目前跨域的解决方案主要有三种

  1. 采用jsonp方式(只支持GET请求)
  2. 采用cors方式
  3. 采用node中间件方式(需要单独部署nodejs服务)

我们这里采用方式2

java代码
response.addHeader("Access-Control-Allow-Origin", "*");
response.addHeader("Access-Control-Allow-Credentials", "true");
response.addHeader("Access-Control-Allow-Headers","Content-Type,Content-Token,Content-User,X-Requested-With");
nodejs 代码
res.header("Access-Control-Allow-Origin", "*");
res.header("Access-Control-Allow-Headers","Content-Type,Content-Token,Content-User,X-Requested-With");
res.header("Access-Control-Allow-Methods","PUT,POST,GET,DELETE,OPTIONS");
res.header("X-Powered-By",' 3.2.1')
res.header("Content-Type", "application/json;charset=utf-8");

这种方式还可以自定义请求头的认证信息

不明白的朋友可以去看阮一峰大神的这篇文章

未完待续 更新于2018-02-26


jasonlive
45 声望13 粉丝

少年贪玩,青年迷恋爱情,壮年汲汲于成名成家,暮年自安于自欺欺人。人寿几何,顽铁能炼成的精金,能有多少?我们曾如此渴望命运的波澜,到最后才发现,人生最曼妙的风景,竟是内心的淡定与从容。