项目的目录结构进行分类规划对可维护性的意义

以前也没有深刻意识到它的重要性。直到后来,去接手一些遗留系统,那种混乱,寻找代码和代码文件多么费力。系统经过了很多人手,人员调岗,人员离职。每个人都有自己的风格,折腾一下,就闪了。丢下一个千疮百孔的系统。

 

人的眼睛是相信现实的东西,没有经历过那种坑,就无法理解。所以当我们怎么说要规划好目录结构,要好的命名方式,一些技术都不以为然。包括我以前也一样,我以前能够接受好的东西,但是我没理解,就不会有深刻发自自觉性去这样做。内心只是想:这个问题不大吧。

因为现实案例最让人印象深刻。总结一下遇到的问题

 

 

 

上面两个是比较坑人的目录结构,接手的人员太多了,加的目录也重复。

 

 

 

 

-------------------------------------------------------

后面这个系统使用mvc框架,相对好,但是也出现不清晰的地方,暂时系统的功能不是很多,所以目录很少,看起来很清晰。但是,随着时间的推移,加的功能越来越多,才会看起来混乱。

 

比如:上面这个curl目录就不太好。不应该放到根目录下的。这样会给人误导,使得接手的技术,某天增加新功能,也会新增加一个文件夹放到根目录。那么,后面功能加的多了,大家都会这样子做。

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

那个时候才去思考解决办法。我一直在想,怎样才能让项目在可控的范围内呢?

出现问题的原因是什么

虽然好的风格在业界都是有共识的。但为什么造成那么混乱的系统。原因是什么呢?

有人说原因是:各个技术人员水平不一样。所以这个问题很难解决。束手无策。

也有人说,原因是,系统经受的人太多了。这个技术维护一段时间,然后另一个技术维护一段时间。这样就造成了千疮百孔。除非公司保证技术人员的稳定性,但这个很难。所以这个问题也很难解决。

仔细,深入去思考。我在想,这些都只是表明上的原因。难道因为这样就没有解决办法吗?

如何解决,很多人也有自己的想法,归纳起来有:

1、要求系统维护人员遵循风格统一。写好规范文档。让大家按照规范来做。提交修改代码,需要进行代码审核,可是这需要成本。一个中小型公司,技术人员有限,都是忙着开发功能去了,抽出时间来审核代码(哪怕是大体审核),也是需要时间投入的。

所以现实情况是,进行代码审核,在很多公司往往做不到。

2、成员培训。归根结底还是要放到人的自觉性上去。所以要经常给大家灌输好的风格意识,进行培训。这个方案其实有效果。具体得依赖于团队技术领导本人的个人影响力,能不能以身作则,用代码示范影响到成员。所以还是依赖于某一个经验丰富且有影响力的人,一旦缺了这个人,就会导致一盘散沙。尤其是当这个人如果离职怎么办呢?

上面办法都是正确的。但是会有阻碍和困难。我在想,能不能做到不依赖于某个特别的人而让团队成员自觉做到呢? 并且,可不可以,忽略掉团队成员技术水平的差异性呢?
 

根据心理学,就是示范效果。虽然大家水平不一样,但是看到一个好的示范,会不自觉的遵守。另外就算其不遵守,也会感到无法使用。自己都会感到羞耻。

比如mvc的框架,定好了controllers,views,models,后面刚入门的人,都能按照目录结构去加代码。

具体要做的是:对系统的代码和目录预先设计好。规划好目录结构。什么目录放哪种类型的文件的。

以前听过一句话说:架构师的目标就是让程序员变得更加不用很费很多精力,按照预先规划设计好的方式去做就可以。

现在看来这个非常有道理。

心理学:如果已经有的东西是混乱的,那么也会觉得痛苦,干脆凑合一下算了

做系统前,把系统的规划好

 

不规划好,后面接手的人就会不知道标准。

 

安装目录包括一下几个文件夹:

 

安装目录/public/

安装目录/app/

安装目录/cache/

 

说明:

1、public目录下是对外开放的目录。也就就是nginx配置指向的目录。目录里面的子目录接下来在详细介绍

2、app,所有源码存位置。

3、cache,模版编译缓存存放到这个里面。为什么要放到这个里面呢?

 

 

public目录下的子目录

 

public/index.php

public/js/

public/images/

public/css/

 

app目录下的子目录

 

app/controllers 控制器文件

app/models 模型文件存放目录

app/views                       模版文件目录

app/config/                    所有的配置文件存放

app/library/                   所有的公共库文件。文件夹名称也可以命名为lib,就是library单词的简写。

app/logs/                      日志文件目录php代码记录的日志信息

app/api/                       里面放一个sdks文件夹。所有的sdk放入里面去。每个sdk一个文件夹。比如sdks/pmsSdk/  sdks/memberSdk/

app/tools/                    一些工具放入到里面去。比如定时脚本,则放入task文件夹中去。app/tools/tasks

 

时间: 2024-10-14 19:58:23

项目的目录结构进行分类规划对可维护性的意义的相关文章

ASP.NET MVC 入门 2、项目的目录结构与核心的DLL

我们新建一个ASP.NET MVC的Web Application后,默认的情况下,项目的目录结构如下: App_Data :这个目录跟我们一般的ASP.NET website是一样的,用于存放数据. Content :这个目录是建议用来存放一下资源文件的.例如CSS.JS.图片等等.当然你不愿意的话,完全可以不放到这里来. Controllers :这个目录是建议将Controller类都放到这里来,方便管理.Controller类的命名必须以Controller结尾,例如一个名为Home的C

求教大神,在MyEclipse创建maven项目,目录结构不对,是什么问题

问题描述 求教大神,在MyEclipse创建maven项目,目录结构不对,是什么问题 这个是我的项目结构 正确的结构应该是下面的,不知道是什么原因,不知道是不是maven没装好,但是用dos输入mvn 测试又是好的 求大神帮忙解答下,感谢,万分 解决方案 你那个目录没有问题的 教程上面创建的只是一个简单的maven工程而已,如同一个j2se工程加入了maven 你创建的是一个dynamic web project,比教程上的内容丰富. 可以跑j2ee项目的哦 没事都可以使用

asp.net比较大型的企业网站的项目、目录结构问题

大型企业网站不同于一般的网站(几个页面就行了),大型网站有大量的页面,权限控制等也很复杂,为了提高开发效率,代码能有效重用,还是得注意一下项目的结构问题,不然乱开发效率是很低的,还不利于维护. 网站文件项目(WebApp) App_Data (重要文件)-- 这里可以放网站配置文件,要设置写入权限. DynamicFiles(常规文件)--存放需要进行读写.上传的文件,CKEdit等网页编辑器要上传的文件等.设置有写入权限. App_Code  供网站后台直接调用的最常用代码,函数等. App_

浅析Android系统的架构以及程序项目的目录结构

Android框架结构 直接上图: 由上图,我们可以看出Android系统架构由5部分组成, 分别是:Linux Kernel(linux内核).Android Runtime(运行时环境).Libraries(类库).Application Framework(应用框架).Applications(应用). 1.1.Linux Kernel Android基于Linux 2.6提供核心系统服务,例如:安全.内存管理.进程管理.网络堆栈.驱动模型.Linux Kernel也作为硬件和软件之间的抽

MVC2.0 用Area 扩展项目的目录结构

Area是MVC2.0里新特性,但是感觉在项目中应用的不是很多,也许是项目比较小吧,没有在意目录结构的整理,举个例子来说吧,比如我们在管理自己项目的后台时候需要建立一个Admin目录,总感觉Admin建在View目录下不是很好,而且对URL显示也不是很完美..比如/Admin/index.aspx- 如果能有一个目录来单独管理Admin 是很完美滴- 在 MVC1.0时没办法实现这个功能,MVC2.0 提供了Area 特性,用来管理越来越庞大的项目目录结构.. 在VS2010里面项目上右键.添加

MVC2.0:用Area扩展项目的目录结构

Area是MVC2.0里新特性,但是感觉在项目中应用的不是很多,也许是项目比较小吧,没有在意目录结构的 整理,举个例子来说吧,比如我们在管理自己项目的后台时候需要建立一个Admin目录,总感觉Admin建在 View目录下不是很好,而且对URL显示也不是很完美..比如/Admin/index.aspx- 如果能有一个目录来单独 管理Admin 是很完美滴- 在 MVC1.0时没办法实现这个功能,MVC2.0 提供了Area 特性,用来管理越来越庞大的项目目录结 构.. 在VS2010里面项目上右

Webpack创建、运行vue.js项目及其目录结构详解

项目环境搭建: 1.安装node 点击下面链接进行下载: node官网 https://nodejs.org/en/ 版本查看: 运行命令行 cmd,然后输入 node -v 查看node版本: 注意:node版本最好新一点好,推荐6.0以上. 2.全局安装vue-cli 在命令行输入: npm install-g vue-cli 3.创建一个基于 "webpack" 模板的新项目 vue init webpack project-name(默认安装2.0版本) vue init we

java web项目的目录结构

 

java web项目 目录结构

问题描述 从别人那里copy了一个java web项目.但是这个项目的目录结构和我之前见过的都不一样.结构是这样的.项目名称:|-.settings|-JavaSource|-WebContent|-test|-.copyarea.db我想把这个项目导入到MyEclipse中,但是无法导入.好像提示找不到.project.最后我自己建立了一个web工程.把项目中的内容都copy进去 这样就可以了.这是为什么呢?我见过的web项目都是这样的结构:|-.myeclipse|-.settings|-.