前端项目结构整理

建立一个好的前端架构是开始开发Web应用或网站的一个基本步骤。良好的实践和编码常规是必不可少的,但是结构呢?我们如何在可控的时间内构思一个好的架构?但最重要的事情是,我们应该从哪里开始?

当我开始思考这个问题时,我意识到一些事情:

我想要一个多页面项目(一个Web应用或网站);
我希望我的项目支持不同的屏幕尺寸和分辨率,换句话说,我希望它是响应式的;
我希望最终产品是可被维护的;
我希望最终产品性能上是出色的;
我希望可以为将来的项目重复使用相同的模板。

my-project
├── .idea                  # 这个是编辑器生成的
├── build                  # Webpack 配置文件放在这里
├── config                 # Vue 基本配置文件放在这里
├── node_modules           # 第三方依赖
├── src                    # 项目源码(核心文件)
│   ├── assets             # 资源文件(js, css, scss)
│   ├── components         # 所有组件
│   ├── js                 # 自己写的 js,里面各种工具类方法等
│   ├── mixins             # 混合
│   ├── router             # 路由
│   ├── vuex               # 状态管理
│   ├── App.vue            # 根组件
│   └── main.js            # 入口文件
├── static                 # 静态资源,一般放 img
├── theme                  # 主题文件,修改的 Element-UI 主题
├── .babelrc               # babel 编译配置
├── .editorconfig          # 代码格式
├── .gitignore             # Git 提交忽略的文件配置
├── .postcssrc.js          # 转换 css 的工具配置文件
├── element-variables.css  # Element 全局定义的变量,不明白为啥放这儿
├── index.html             # 主页模板
├── package-lock.json      # 用来锁定依赖的版本号(NPM 自动生成)
├── package.json           # 项目基本信息
project
    \css
    \imgs
    \js
        \controllers
            pageOne.js
            pageTwo.js
        \libs
            angular.js
            jquery.js
            analytics.js
        \plugins
            jquery.tooltip.js
            textResize.js
            formValidation.js
        \views
            pageOne.js
            pageTwo.js
    \scss
        \framework
            _core.scss
            _forms.scss
            _input.scss
            _mixins.scss
            _variables.scss
        \layouts
            _all.scss
            _phablets.scss
            _tablets.scss
            _desktop.scss
            _desktop-large.scss
            _retina.scss

            \pageOne
                _all.scss
                _phablets.scss
                _tablets.scss
                _desktop.scss
                _desktop-large.scss
                _retina.scss

            \pageTwo
                _all.scss
                _phablets.scss
                _tablets.scss
                _desktop.scss
                _desktop-large.scss
                _retina.scss
        \libs
            _animate.scss
            _normalize.scss
            _reset.scss
        \plugins
            _jquery.tooltip.scss
            _jquery.fancyInput.scss

文件夹树注解
imgs

存放所有的图片文件:.png、.jpg、.jpeg、壁纸等。

示例:icon.png、home-background.jpeg、userAvatar.jpg。

js(主文件夹)

存放.js文件。子文件夹组织情况如下:

\controllers(子文件夹)

存放angular控制器,每一个控制器都有一个与对应视图相同的名字。比如,如果home.html需要一个angular控制器,你可以创建一个像这样的文件:project\js\controllers\home.js。

示例:home.js、user-registration.js、user-login.js

\libs(子文件夹)

用于存放JavaScript库,当然这里不包含插件。

示例:jquery-latest.js、angular.js、googleAnalytics.js

\plugins(子文件夹)

插件需要依赖关系来工作,而库不需要,这也就是为什么这里创建两个文件夹的原因。

示例:jquery-fancyInput.js、restangular.js、customPlugin.js、jquery-airport.js

\views(子文件夹)

存放所有表象的东西,每个文件都与对应的视图名称相同。例如,如果home.html需要一些效果、材料以及插件初始值,你可以创建一个像这样的文件:project\js\views\home.js。

示例:home-animations.js、user-registration.js、user-login.js、site-animations.js

CSS(主文件夹)

这个文件夹包含了所有从主SCSS文件中生成的CSS。例如home.scss会在该文件中生成对应的home.css文件。

\libs(子文件夹)

即使是对CSS文件,我也会区分库和插件,这里有些CSS库例子。

示例:_meyers-reset.scss、_normalize.scss、_animate.scss、_960gridSystem.scss

\plugins(子文件夹)

CSS文件包含于该文件夹中是使JavaScript插件工作的必备风格。

示例:_jquery-fancyInput.scss、_jqueryTooltip.scss

\framework (子文件夹)

我决定在这个目录中存放scss文件以共享到整个项目页面,框架子文件将以下面的方式组织:

_variables.scss(项目变量声明——colors、spacings等)
_mixins.scss(项目mixin声明——typography、clearfix、animations等)
_forms.scss(自定义表单样式和重置)
_input.scss(自定义输入样式和重置)
\layouts (子文件夹)

这是一个敏感的部分。这个目录中的文件以这种方式组织:它们涵盖所有屏幕分辨率、遵循移动第一的原则。所以,你应该使用_all.scss声明你自己的风格。在该文件中的规格声明是对所有屏幕尺寸和所有视图都有效的。如果你希望你的网站适应性强的话,就不要仅仅是重写规则,为其他屏幕分辨率声明它们。

文件夹组织结构如下:

phablets (481up) _phablets.scss
tablets and small laptops (768up) _tablets.scss
desktops (1030up) _desktop.scss
desktops with large screens (1204up) _desktop-large.scss
retina displays exceptions (@2x) _retina.scss
这些文件将把握布局异常,被称为mediaqueries。

请注意:这些文件共享于所有视图(HTML页面)。这就是为什么你需要在scss\layouts文件下创建一个新的文件夹以给定一个特定的风格到一个特定的页面。

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

推荐阅读更多精彩内容