技术架构规范标准

《技术架构规范标准》由会员分享，可在线阅读，更多相关《技术架构规范标准（15页珍藏版）》请在装配图网上搜索。

1、 1 引言1.1 目的通过对系统整体架构和技术规的描述，为下一步大规模设计开发提供根底和规。1.2 对象与围项目管理人员，开发人员，测试人员。1.3 概述系统一期，以实现功能为主，效率性能为辅，但设计兼顾未来性能的扩展，以减少未来重构的工作量。webapp按逻辑分为两层，第一层用户服务接入，第二层部服务。第一层一期不分模块，以二级目录形式表示不同模块，第二层根据不同服务分模块，第一层和第二层之间使用hessian通信。第一层和第二层独立部署，第二层的不同模块也可以独立部署。下一期考虑第一层分模块的二级域名独立部署，并实现单点登录。web app采用集群负载均衡，数据库采用负载均衡和读写别离，以

2、满足一定的性能需求。 文档描述了各层结构和模块使用的技术和框架。最后描述了开发的规和用到的开发工具。文档只是描述了一期的架构，2 系统架构图一期系统架构如下3 层次和模块233.1 前端负载均衡nginx是一个口碑很好的开源免费WEB服务器，国很多大型都转选nginx平台，比如腾讯，豆瓣等。Nginx可以实现动静别离和web app的负载均衡。3.1.1 动静别离动静别离可以很好得分担服务器的负载，有两种方式实现动静别离。1使用2级域名，配置专门的静态文件服务器。2利用nginx的url转发功能，把静态请求转发到静态服务器或在nginx本地处理，动态请求转发到应用服务器。我们目前部署上采用第二

3、种方式，同时也实现第一种方式。系统可以配置动态服务器地址和静态服务器地址，在生成页面时获取这两个地址，对图片、js脚本、css和静态页面使用静态配置生成url，对ajax请求和动态页面使用动态服务器地址生成url。3.1.2 负载均衡nginx可以配置upstream服务器组，实现组的负载均衡。通过ip_hash的方式把动态请求转发到组的某台服务器，同时保证客户端在IP不变的情况下一直访问同一台服务器，解决session保持问题。3.2 Web app前端，基于j2ee，spring框架开发。3.2.1 页面展示和控制系统有三种页面方式。1 动态同步请求，通过velocity模板生成页面，客户

4、端刷新整个页面。2 ajax异步请求。Ajax异步请求又有三种形式：与velocity模板结合返回html串；返回json格式；直接返回简单的字符串。3 模板生成的纯静态页面前台页面采用的框架和第三方技术有：1 jquery-core 事件处理，ajax请求，页面刷新。2 Jqzoom 图片放大器3Jquery-validator输入验证3.2.2 权限安全控制使用apache shiro框架实现权限控制。Shiro是一个强大、使用简单的权限安全框架。同时Shiro也能与cas单点登录整合，方便在下一期扩展多个应用模块。框架把权限系统分成subject当前用户，manager(管理所有用户)，

5、realms(权限数据)三层。支持基于实际资源和基于角色的权限校验，同时我们扩展shiro的UsernamePasswordToken，Realm实现基于验证码和数据库用户密码的用户登录验证。在过滤器层，我们暂时只使用shiro的3种类型过滤器控制访问：1AnonymousFilter 匿名过滤器 任何人可以访问。2AuthenticatingFilter 认证过滤器 必须通过身份认真才能访问跳转到登录页面。可以对当前subject直接调用方法完成判断是否登录，登录，注销等操作，方便对登录功能的扩展。3.2.3 控制器层采用spring 基于注解的控制器，控制器支持velocity视图返回，a

6、jax json返回和ajax text返回。3.2.4 数据验证使用和扩展apache的common-validator。3.2.5 逻辑层采用spring基于注解的事务控制。3.2.6 数据持久层采用ibatis框架，基于sqlmap配置实现数据的读写，sqlmap配置可以控制底层sql语句，便于数据库的调优。3.2.7 缓存的处理使用缓存可以降低与数据库的交互次数，极大提高系统性能。我们采用ehcache缓存框架。用到两种缓存方式：1 页面缓存：直接在过滤器层对页面进展缓存处理，在过滤器层就可以返回缓存的页面，不用转到控制器去处理。对于页面比拟复杂，调用业务逻辑比拟多的页面，采用页面缓存

7、效果很好，比如首页。2 基于注解的方法缓存，可以对方法的返回值缓存，存入的参数可以组成key。可以在逻辑层使用缓存，也可以在持久层试用。对于请求简单，访问量大，但修改频率比拟低的数据进展缓存可以达到很好的效果。比如商品分类，系统数据字典，地区等数据。Ehcache支持分布式缓存，ehcache支持服务器之间通过rmi调用保持所有服务器之间缓存同步。缓存的两种过期机制：1 定时过期，直接通过ehcache的配置确定缓存过期频率。2 主动通知，管理员在后台系统进展某些操作后，通过hessian远程调用通知应用服务器缓存过期。只需通知一台应用服务器，应用服务器之间通过ehcache自带分布式缓存复制

8、方式同步缓存。后台管理系统可以提供刷新缓存功能，管理员在后台管理系统主动刷新缓存。3.2.8 去其他模块之间的通信通过hessian远程调用框架，实现与其他模块功能之间的通信。Hessian是一个基于的二进制远程过程调用框架，比webservice更高效。与Spring框架很好结合，开发简单。3.3 后台管理系统管理员用来维护的系统。基于j2ee spring框架。与前台使用到的技术差不多，现只介绍不同点：3.3.1 页面的展示大局部请求采用页面刷新的机制。头部，中部左侧菜单和底部固定不变。中部右侧iframe为主操作区，每次操作刷新页面。商品描述的编辑需要使用到富文本编辑器，我们采用开源的T

9、inyMCE，TinyMCE在国应用比拟广泛。3.3.2 缓存机制后台系统访问不是很频繁，同事管理员需要的是实时的数据，所以后台管理系统不对数据进展缓存。3.3.3 权限管理采用sping security框架进展权限的控制，基于用户、角色和资源的授权机制。3.4 支付模块：支付模块主要功能是订单的管理，与银行等支付系统的交互。基于j2ee spring框架。采用spring mvc模式。3.4.1 与银行和其他支付系统的交互需要提供一个Url地址，供银行在用户完成支付后回调，通知系统已经支付成功。3.4.2 与部模块之间的通信主要来自前端的调用。基于hessian机制。3.5 物流模块支付模

10、块目前主要功能是调用物流公司的接口跟踪物流状态，随着系统的不断开展，在拥有自己的物流后，可能开展成一个庞大的系统。基于j2ee spring框架。采用spring mvc模式。基于hessian机制对外提供远程效用服务。3.6 模块模块主要用来向客户发送。基于j2ee spring框架。采用spring mvc模式。3.6.1 发送使用 java mail包发送，支持以固定模板发送。3.6.2 定时发送使用spring+quartz框架实现定时任务发送。3.6.3 与部模块之间的通信为前端和后台管理系统提供远程调用服务。基于hessian机制。3.7 短信模块短信模块主要用来向客户发送短信。基

11、于j2ee spring框架。采用spring mvc模式。3.7.1 发送调用短信设备api发送短信，支持以固定模板发送短信。3.7.2 定时发送使用spring+quartz框架实现定时任务发送短信。3.7.3 与部模块之间的通信为前端和后台管理系统提供远程调用服务。基于hessian机制。3.8 进销存模块调用A8系统接口，实现库存的管理。基于j2ee spring框架。采用spring mvc模式。3.8.1 Web service调用采用spring+xfile 框架调用a8系统webservice。3.8.2 与部模块之间的通信为前端和后台管理系统提供远程调用服务。基于hessia

12、n机制。3.9 搜索模块为提供搜索服务。包括商品检索和问答式搜索的问题检索。基于j2ee spring框架。采用spring mvc模式。3.9.1 检索框架我们使用国产开源coreSeek搜索引擎，基于俄国开源项目Sphinx研发并独立开发的搜索引擎。自带中文分词器mmseg，有大量中文文档。提供JAVAAPI。索引建立效率高并且与业务无关。在国有大量成功案例。3.9.2 与部模块之间的通信为前端提供远程调用服务。基于hessian机制。3.10 第三方服务调用模块调用第三方合作服务商的接口。基于j2ee spring框架。采用spring mvc模式。3.10.1 Web service调

13、用采用spring+xfile 框架调用第三方服务webservice。3.10.2 与部模块之间的通信为前端和后台管理系统提供远程调用服务。基于hessian机制。3.11 对外服务接口对外部系统提供webservice接口服务3.11.1 Web service服务采用spring+xfile 框架对外提供webservice服务。3.11.2 与部模块之间的通信调用部其他模块的服务。基于hessian机制。3.12 数据库使用mysql5.5数据库存储数据，并使用读写别离机制提高数据库性能。3.12.1 数据库读写别离我们使用开源的mysql代理Amoeba实现数据库的读写别离，把写请求

14、发送到主服务器，读请求发送到从服务器，主从之间通过mysql自带的复制机制实现数据的同步。3.12.2 数据库负载均衡Amoeba支持轮询和权重两种负载均衡机制，我们使用权重负载机制实现读服务器的负载均衡。3.12.3 数据库表引擎的选择主服务器必须使用innodb支持事务的存储引擎，行级锁表。而从服务器可以考虑使用myisam引擎，不支持事务，表级锁表，具有更高的读写效率，但不支持外键。3.12.4 主从数据库的差异优化主服务器只需要建立唯一索引和外键约束，其它针对对查询优化的索引可以不建立，这要可以提高主服务器的性能。从服务器字段使用char而不用varchar，没有varchar, te

15、xt, blob字段的表是静态表，反之是动态表，静态表的检索效率要比动态表好假设干倍。4 工程命名工程以动物命名，结合了各种动物特征与我们各工程的职责：公共接口工具 magpie喜鹊 前台服务 bull公牛物流 cheetah 猎豹支付 lion 狮子进销存接口 fox狐狸搜索 dog 狗 eagle 鹰短信 pigeon 鸽子后台管理 horse(马)调用第三方合作接口 mouse(老鼠)对外服务接口 camel(骆驼)5 工程规5.1 工程目录结构src 源码WebContentWEN-INFlib jar包config 配置文件views 视图模板layout 布局模板screen 页面

16、模板 各模块common 公共的 styles 样式文件 resources资源文件 scripts js文件common 公共js 各模块，各开源js项目5.2 包结构包命名根本原那么：小写字母开头，如果有多个单词，除第一个单词之外的单词首字母大写5.2.1 公共工具接口工程公共工具：.zjdelai.emall mon.util 各层的公共基类：.zjdelai.emall mon 下的各子包 远程调用公共dto：.zjdelai.emall.提供服务的工程名.remoting .dto.业务子模块远程调用公共接口：.zjdelai.emall.提供服务的工程名.remoting.inte

17、rfaces.业务子模块第三方开源包的扩展：.zjdelai.emall mon.第三方开源包名5.2.2 各模块工程数据对象：.zjdelai.emall.工程名.domain.业务子模块持久层dao接口： .delai.emall.工程名.dao.业务子模块持久层dao接口实现： .zjdelai.emall.工程名.dao.业务子模块.持久层框架名ibatis持久层sqlmap： .zjdelai.emall.工程名.dbMap.业务子模块.数据库类型(mysql)业务逻辑接口： .zjdelai.emall.工程名.service.业务子模块业务逻辑实现： .zjdelai.emall

18、.工程名.service.业务子模块.impl Web控制器action： . zjdelai.emall.工程名.web.action.业务子模块Web验证器：. zjdelai.emall.工程名.web.validator.业务子模块Web过滤器：. zjdelai.emall.工程名.web.filter工具：.zjdelai.emall.工程名.util远程调用接口实现：.zjdelai.emall.工程名. remoting.interfaces.业务子模块.impl5.3 类、接口命名类命名根本原那么：首字母大写，多个单词的首字母大写接口命名根本原那么：以大写字母I开头，如果有多

19、个单词，每个单词头字母大写I数据对象：数据库表名.javaDao接口：I+数据对象名+Dao.javadao实现：数据对象名+Dao+框架名(Ibatis).javasqlmap：数据对象名.xml业务逻辑接口：I+数据对象名+Manager.java业务逻辑实现：数据对象名+ManagerImpl.javaWeb action： domain名+Action.javaWeb validator： domain名+Validator.javaDto：*Dto.java远程调用接口： I+数据对象名+Sercice.java远程调用实现：数据对象名+SerciceImpl.java5.4 变量和

20、方法命名类变量、局部变量命名规：变量名首字母必须小写，如果该变量名有多个单词组成，后面的单词首字母大写，单词与单词之间不要使用_做连接。类常量命名规：所有字母大写，如果有多个单词组成，单词与单词之间以_隔开。而且该变量必须是公共、静态、final类型。方法命名规：方法名首字母必须小写，如果该变量名有多个单词组成，后面的单词首字母大写，单词与单词之间不要使用_做连接。方法参数名命名规：参数名首字母必须小写，如果该变量名有多个单词组成，后面的单词首字母大写，单词与单词之间不要使用_做连接。5.5 注释5.5.1 类、接口的注释类、接口必须要有注释。描述类、接口的功能，作者，版本，最近修改时间。类的

21、注释必须写在该类的声明语法之前。在注释中要描述该类的根本作用，作者，日期，版本。/* * #功能类 * * author #X * version X.X.X 修改时间 作者 */5.5.2 类、接口的变量和常量注释类、接口的变量和常量必须有注释，变量和常量注释必须写在变量和常量定义之前，简单描述其代表的意义。/* #*/5.5.3 类、接口方法注释方法必须要有注释，方法注释必须写在方法定义之前。该注释包括：方法其功能的简单 描述，方法的参数、返回值类型、返回值意义简单的描述，跑出异常描述/* * #功能 * param a a参数的意义 * param b b参数的意义* return 返回类型 返回的意义 * throws #异常 * throws #异常 */5.5.4 逻辑代码注释逻辑代码必须注释。每个条件判断和每个循环都需要有注释。其它关键代码也需要注释/* * 当#的时候 # */If ( ) /* 循环#*/for /* #*/程序代码6 开发环境和工具JDK1.6Eclipse3.7Jboss5.1.0Mysql5.57 部署环境Red Hat Enterprise Linux Server release 5JDK1.6Jboss5.1.0Amoeba for mysql Mysql5.515 / 15