后端项目开发规范

概述

最近接手的项目、带领的团队人员越来越多,为了保证项目可预期上线,需要有一套方案统筹所有人的意识,因此专门编写此文档,针对项目初期、开发中、上线后做出相关的规范。

新项目开始的准备工作

  1. 安装基础 packages, 提高开发效率;
  2. 创建 Migration 和 Seeder, 统一所有开发者的本地环境;
  3. 编写环境部署文档, 方便后来人加入开发;
  4. 使用项目所属的 官方账号 注册第三方服务;
  5. 项目开始前, 再多花一天时间寻找有没有可以加速开发的 package 包, 提高开发效率.

保持服务器稳定性

开发阶段, 服务器使用最小资源配置, 不要使用平台提供的各种 IAAS 服务。上线后, 要根据实际情况扩展服务器性能, 如增加负载均衡, MYSQL 主从,并且还要完善以下工作:

  1. 添加服务器监控 (Bugsnag, 监控宝,sentry);
  2. 备份数据库, 并能快速的回滚到某个备份阶段;
  3. 服务器做好镜像, 能快速回滚;
  4. 做好负载均衡, 增加服务器的负载能力;

开发原则

服务器代码开发需要遵循一个原则 -- KISS (Keep It Sample And Stupid)

  1. 不要使用 Repository 设计模式, 减少代码的复杂度;
  2. Route 和 View 必须遵循 Restful 设计规范;
  3. HTML 代码不要使用 PHP 生成, 减少前端开发人员工作量;
  4. 统计代码要直接写在页面里, 不要通过读取数据库生成, 减少前端开发人员工作量;
  5. 在本地开发环境, 默认 id 为 1 的用户为管理员账号, 并且无需账号密码即可登录, 减少调试工作;

生产环境服务器部署原则

  1. 必须使用 Ubuntu 16.06 LTS 版本,并使用Ubuntu 14/16 下的 Laravel LNMP 线上环境自动部署脚本安装。
  2. 统一 alias,运行 vi ~/.bashrc 命令,配置以下 alias
alias cdproduction='cd {生产环境地址}'
alias cdstaging='cd {测试环境地址}'
        
#例如
alias cdproduction='cd /var/www/redbang.cn/production'
alias cdstaging='cd /var/www/redbang.cn/staging'

上线之前必须检查的内容

  1. 产品是否能够正常安装、注册、使用?
  2. 使用的第三方服务的账号或者 API key 是否已经切换到生产环境?
  3. 错误异常报警和监控系统是否添加?
  4. 测试数据是否需要移除,如果需要的话是否已经清除完毕?
  5. 上线的时间点和方式是否已确认?
  6. 确认工程师的时间安排?(保障线上 bug 的及时修复)
  7. 线上环境是否已准备好?
  8. 提交到应用市场的申请资料是否齐全?
  9. 数据库是否已经做好备份?
最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 214,875评论 6 496
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 91,569评论 3 389
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 160,475评论 0 350
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 57,459评论 1 288
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 66,537评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,563评论 1 293
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,580评论 3 414
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 38,326评论 0 270
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,773评论 1 307
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 37,086评论 2 330
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 39,252评论 1 343
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,921评论 5 338
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,566评论 3 322
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 31,190评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,435评论 1 268
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 47,129评论 2 366
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 44,125评论 2 352

推荐阅读更多精彩内容

  • Android 自定义View的各种姿势1 Activity的显示之ViewRootImpl详解 Activity...
    passiontim阅读 171,996评论 25 707
  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,647评论 18 139
  • 作者 James Hamilton “系统-管理员” 的比例通常可以作为一种理解大规模服务的管理开销的粗略度量方式...
    数行者阅读 1,393评论 0 3
  • 感受:自己临摹感觉也会画一点,看到白璐抑制不住啦,太美了。 发现:线条左下角有个下挂了。今天比昨天稍微快了一点。 ...
    小燕lucky阅读 188评论 2 0
  • 总以为,这个世界是美好的,所有的人也是友好的,可是结果不尽其然…… 不知道别人是如何处理身边的所谓是...
    爱上空想的蝶儿阅读 177评论 0 0