我的web系统设计规范
Posted jsper
tags:
篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了我的web系统设计规范相关的知识，希望对你有一定的参考价值。
以下是我自己在工作中总结的，仅供参考。
·应对所有用户输入进行trim()去除两头空格，若是需要空格的应用 转义代替，不应在js里trim()，而应该在数据库端或后端控制，且只在一处拦截控制，更改策略时只改一处代码。
·不应使用frameset框架集，应使用iframe代替frameset，因为frameset页面无法执行js，若想在frameset页面弹出内容是无法实现的。
·项目中应避免同时使用int和long，统一使用一种类型，因为他们之间相互转换非常不方便，容易导致错误。
·每个页面都应包含一个全局控制的js文件。
·前端设计应考虑一个扩展js库，对js原生对象的方法和属性及事件使用prototype进行扩展，以便随处直接调用，应避免写成第三方函数，应扩展的方法包括String的replaceAll()、hashmap类型等。
·同样功能的方法只定义一次，应杜绝重复定义，这样会造成代码混乱，维护麻烦。
·前端不应使用js内置的alert函数进行提示弹出，因为alert在不同的浏览器下显示样式不统一，且会阻塞线程，不适合存在计时器程序的页面使用。应使用第三方html控件。
·通过get方式传参，若传入boolean类型的值，是无法直接进行==判断的，因为get传的是字符串。
·js判断boolean类型尽量使用==true/false具体值进行判断，避免使用if(!boolean)这样的用法，因为undefined、false、null都可能满足条件。
·如果项目用到ajax，应配置全局ajax事件处理，如jquery的ajaxSetup，利用before及complate回调函数实现网速监测，利用error函数实现默认错误处理。
·若需要设计多级关联表（多张表存在级联关系），子表、孙表最好都加上顶层表的id，这样在删除时直接根据id删除比数据库自己的级联删除或通过程序级联删除性能高。
·数据库表添加字段时必须考虑该字段是否应创建索引，测试库数据量小不易发现问题，线上库数据量大时查询效率慢是致命的。
·对于功能较多，使用了前端资源缓存，bug风险较大的系统应该设计动态请求js代码并执行的功能，用于在紧急时刻临时性解决前端bug.动态请求一个action,action直接输出js代码.
·定义公共全角半角字符替换函数
·编码实现必须严格按照规范、按照约束，所有的处理逻辑必须写注释，有的地方该举例的应举例，该表明数据结构的要表明数据结构，该写原因的要写原因。
·对每个功能点进行编码，并在相关代码文件及位置添加编码注释，用于通过IDE快速定位功能所涉代码，便于功能维护。
·对每一次用户登录都记录日期时间，对所有操作记录日志。
·前端像向后台数据库保存数据应避免将"null"、"undefined"、"NaN"等JS产生的赃数据保存进库里，否则会影响数据分析与计算。
·集合数据去重复，前端可用obj[key]=value，后台可用hashmap，它们都利用key不重复的机制进行排除重复，这样比写循环效率高且不容易出错。
·设计时应考虑系统升级时给在线用户造成的影响，应留有在升级时对用户弹出提示的通道功能，即实时推送功能。
·如果使用MVC或多层设计设计模式，传递参数并获取返回值应严格按照方法调用、参数返回规范进行，不应采用如在M传给V参数对象，V的方法无返回值，V修改参数对象，M再直接读取参数对象里的值，应使用M传给V参数对象，V处理并创建返回值变量，V的方法返回该变量。为什么这么做？因为如果以后要对各层进行剥离，使用远程调用，那么M层就无法引用V里的参数对象了，他们跨机器、跨系统、跨内存了，引用无效。
·网页表单设计时，输入框应有两个属性，一个原值，一个最新值，用于保存时判断哪些值发生了改变，应仅对发生改变的字段进行更新，减少网络数据传输量，减少数据库操作量。
·若页面不想缓存，可在<head>标签内添加
<META HTTP-EQUIV="Pragma" CONTENT="no-cache">
<META HTTP-EQUIV="Cache-Control" CONTENT="no-cache">
<META HTTP-EQUIV="Expires" CONTENT="0">
·js文件头部应定义编码方式，utf-8。
·数据库表设计，业务功能保存时，如果存在外键字段，引用时最好不要直接引用id，应在对方表里创建具有唯一性的字段，并引用那个字段。这样做为了后期数据库升迁时，避免处理id带来的麻烦，也可在数据库发生严重故障时能便于数据对应及恢复。
.验证码使用后立即销毁，否则，用户可以通过非法手段重复提交数据。
以上是关于我的web系统设计规范的主要内容，如果未能解决你的问题，请参考以下文章