generator-ivweb 基于react-redux的多页脚手架

背景

每个公司甚至每个项目组,在开发新项目的时候都会有一些自己特色的东西,比如公共组件,ajax请求拦截处理,内部积累的一些业务逻辑等等,如果没有自己的脚手架,那么拷贝代码成为常态,每个项目的结构,甚至是构建配置都会由很大差异,导致代码维护成为一个难题。

简介

generator-ivweb是由腾讯IVWEB团队设计的脚手架,基于团队开源项目feflow,feflow是一个前端集成开发环境,详细介绍可以看这里:feflow

技术栈
  • React
  • redux
  • less
  • axios
  • webpack4
    ...
让你心动的地方

相对于官方脚手架,我们不仅仅是初始化一个项目,更多的是满足实际开发场景。

  • 支持多页项目
  • 页面适配
  • 内联语法
  • 构建优化
  • 丰富的默认配置文件

架构设计

目录结构
generator-ivweb-app
├── README.md
├── package.json
├── .babelrc
├── .editorconfig
├── .eslintrc.js
├── .gitattributes
├── feflow.json
├── config.json
├── node_modules
├── dist
└── src
    ├── assets
    ├── middleware
    ├── modules
    └── pages
        ├── otherPage
        └── indexPage
            ├── index.html
            ├── index.js
            ├── index.less
            ├── index.js
            ├── init.js
            ├── pageComponent.js
            ├── actions
            ├── assets
            ├── components
            └── reducers
  • 开发和构建
    这里我们默认都是src为开发目录,dist为打包目录,当然你可以在feflow.json中配置为其他输出目录。
{
    "builderOptions": {
        "outDir": "dist" //输出目录名称
    }
}
  • 多页目录
    多页放在pages目录下,每个页面一个单独文件夹,访问的路径如下:
https://xxx.xxx.xxx/xxx/indexPage.html
https://xxx.xxx.xxx/xxx/otherPage.html
页面结构化继承(多页设计)

正常来说,多页应用只需要有自己的入口就可以,在入口文件我们可能需要做这么几件事

  • 注入store
  • 设置全局配置
  • 页面监控
  • 将组件渲染到页面
    ...
    上面只是列举了一些基本的东西,当然还会有很多,甚至是一些跟业务相关的基本信息,而这些东西对于一个工程下的多个页面来可能都是一样的,不仅操作不方便,维护也很麻烦。这里我们提出一个概念:页面结构化继承
    继承大家都很熟悉,而react是可以用function/class方式来写组件的,我们在用class方式写组件就是继承自React.Component,那么对于这些公有东西我们也可以封装成一个组件,通过继承的方式来获取这些能力。
创建BasePage 页面继承
创建BasePage
继承basePage

此处只写了对于多页的应用,对于复杂的单页应用同样是适用的。

组件划分

通常我们在开发一个单页应用都会抽离一些公共组件,比如title-bar

首页 博客页
image.png
image.png

如果这里是个多页应用,同样是可以公用的,因此对于多页应用来说,组件应该是这样的结构:

image.png
状态管理

每个页面的状态管理同样是可以抽离一些公共action和reducer,比如登录逻辑

image.png
模块化

鉴于脚手架默认是多页项目,我们把公共模块放到外层目录,减少跟每个页面的耦合。

modules
├── common //公用js模块
├── components //公用组件
├── globalStore //store配置,包含中间件注入
└── page //页面结构继承组件
构建

这里使用feflow的构建器:builder-webpack4,当然这个东西同样是可以配置的,甚至可以根据我们的官方构建器写自己的构建器。

项目配置

脚手架是基于feflow的,因此feflow.json文件是feflow项目的基础配置,包含了一些构建选项,比如输出目录,域名,webpack相关等。

{
    "builderType": "builder-webpack4", //构建器类型
    "builderOptions": {
        "product": "", //产品民称
        "outDir": "dist", //构建输出目录
        "minifyHTML": true,
        "minifyCSS": true,
        "minifyJS": true,
        "inlineCSS": true,
        "usePx2rem": true, //是否转化px
        "remUnit": 37.5, //rem基准
        "remPrecision": 6, 
        "inject": true, 
        "useTreeShaking": true,
        "port": 8001, //项目端口
        "hot": true,
        "externals": [
            {
                "module": "react",
                "entry": "//11.url.cn/now/lib/16.2.0/react.min.js?_bid=3123",
                "global": "React"
            },
            {
                "module": "react-dom",
                "entry": "//11.url.cn/now/lib/16.2.0/react-dom.min.js?_bid=3123",
                "global": "ReactDOM"
            }
        ]
    }
}
其他

项目默认是不显示构建相关配置的,一方面,我们有暴露一些基础配置项,另一方面避免多人协作开发更改配置问题,如果你想查看或修改可以使用命令展示(不建议修改配置)

feflow eject

优势

多页支持

generator-ivweb先天支持多页应用,而不用我们再去webpack中配置,在开发中只需要在pages下创建多个目录即可。

页面适配

项目默认接入rem适配,会自动把px转成rem,当然,如果某些地方不想被转化,有两种方式:

  • 修改px写法
    height: 300Px;
    
  • feflow.json中设置usePx2rem为false
  1. 打包优化

generator-ivweb默认使用builder-webpack4构建,webpack4中所做的一些优化,比如treeShaking都有用到。并且这里我们默认给react和react-dom加了外链cdn(使用我们自己的cdn,如果不放心可以改为自己的cdn)。

  1. 内联语法

    比如一些meta标签,页面loading等,都可以通过内联方式引入

    <!--inline[/assets/inline/meta.html]-->
    

    还有一些js文件我们可能也需要内联到html中提前加载

    <script src="amfe-flexible/index.js?__inline"></script>
    
  2. 多样化配置文件

    项目默认集成了gitignore、eslint、editorconfig等配置,为仓库管理和开发提供了便捷。

├── .babelrc
├── .editorconfig
├── .eslintrc.js
├── .gitattributes

如何使用

# 安装feflow
npm install feflow-cli -g
# 安装脚手架
feflow install generator-ivweb
# 启动项目
feflow init
9b110b14-0d91-474a-a413-61e8a3c5c3a3.gif

未来规划

  1. 添加测试用例,提高稳定性。
  2. 完善脚手架内容,提供更高效的内容

项目地址

https://github.com/feflow/generator-ivweb, 欢迎大家提issue以便于我们改进。

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 206,378评论 6 481
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 88,356评论 2 382
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 152,702评论 0 342
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 55,259评论 1 279
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 64,263评论 5 371
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,036评论 1 285
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,349评论 3 400
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,979评论 0 259
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 43,469评论 1 300
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,938评论 2 323
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,059评论 1 333
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,703评论 4 323
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,257评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,262评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,485评论 1 262
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 45,501评论 2 354
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,792评论 2 345

推荐阅读更多精彩内容