通用软件项目结构分享

还记得刚开始写程序的时候,那时候用的是PHP,没有使用任何框架,所有文件几乎堆在一两个文件夹中,杂乱不堪,一旦项目变大,光找找对应的文件都得花费一大堆时间,严重影响效率,而且可扩展性为零,更别说让别人看你的代码了,只怕你自己都会看晕掉。

所以,拥有一个结构清晰的文档结构对一个软件项目来说至关重要,清晰的文档结构使得我们的源码可扩展性高,容易理解和阅读,也能提高我们写代码的效率。

例如,我们使用的各种框架都拥有良好的文档结构,各个模块各司其职,将相应的代码文件放入对应模块的文件夹中,有条有理,当然,在框架的基础上还需要我们根据实际情况来扩展定制我们自己的文档结构。

程序设计的时候有一种叫“MVC”的模式,对应的文档结构也会遵循这种模式来进行设计,下面就介绍基于“MVC”的一种通用软件项目结构设计。

结构图如下:

入口文件

单一入口模式的入口文件,会对请求进行路由,转发到对应的控制器方法,go里面的一般是 main.go ,php中的就是 index.php 了。

conf

配置文件夹,存放系统配置相关参数,比如redis地址配置、数据库地址配置、日志结构配置、rpc配置等

controller

控制器,MVC中的C,参数输入输出的入口,入口文件将路由解析到具体的控制器方法进行处理,控制器再去调用相关服务获取结果,输出到前端

data

存放一些数据文件,比如产生的日志文件,上传文件缓存区等

helpers

可以将全局使用到的函数放在这里,即辅助函数

model

模型,MVC中的M,应用程序中用于处理应用程序数据逻辑的部分,通常模型对象负责在数据库中存取数据,但在细分出一层专门处理逻辑的service层之后,model一般只设置表数据结构,整合一些通用数据库操作函数

service

服务层,专门用来处理逻辑的一层,它的直接上级是controller,输入数据来自controller,输出数据返回给controller

public

公共层,或者叫 common,一般用来存放静态文件,比如js、css、图片等

views

视图,MVC中的V,存放html,xml等前端文件

test

测试用例,日常编写测试用例是一个好习惯

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

推荐阅读更多精彩内容