本文主要分三部分,分别是:后台核心业务逻辑、桥梁辅助控制和前台显示页面。
本Web开发环境综合了多种工具,包括Maven包管理与编译工具、Dubbo分布式服务框架、MyBatis数据持久化工具、Linner页面管理工具和Handlebars Js模板引擎等前卫的开发工具。
首先介绍一下:后台核心业务逻辑搭建。
1. 后台核心业务逻辑搭建
后台核心业务逻辑大致分为三个层次:最底层的核心数据逻辑层(biz层),中间层Dubbo服务实现层(service-impl层)和Dubbo服务接口层(service-client层)。此外还有公共的jar包管理父工程(parent工程),公共业务逻辑工程(common工程),任务调度工程(task工程)和总的maven管理工程。
示例如下图:
接下来我会按照搭建顺序简单介绍一下相关工程的配置:
基本的顺序是parent工程→biz工程→common工程→task工程→service-client工程→service-impl工程。
1.1 基本jar包管理和服务环境配置parent工程
parent工程结构如下图所示:
parent工程主要包括pom工程配置文件,filters文件下的三个开发环境配置文件和maven打包bat批处理命令文件。
首先介绍一下parent工程的pom文件:
(1) 不同的打包环境配置,使用不同的打包配置便利了项目整个开发,测试到生产流程的统一化管理。默认将开发环境激活,配置如下图所示:
(2) 编译时设置不对指定的资源文件进行替换。包括Freemarker模板文件ftl,静态-dynamic.xml文件,mybatis动态SQL Mapper文件。如下图:
(3) 工程编码和打包插件配置:包括工程编码插件Java版本1.7,生成javadoc插件,打包Java源码插件,导入eclipse工程插件等的配置。如下图所示:
(4) 单元测试覆盖率统计插件配置:
忽略对以下路径文件的单元测试覆盖率统计:action、webapp、interceptor、taglib、domain、model、dto和util/DataFormat.class。下图相应配置信息:
1.2 biz核心业务逻辑工程
按模块划分的动态SQLMapper文件:示例:SamStateInfoMapper.xml,如图1-21
序号①指定mybatis基本配置文件sqlMapConfig.xml的路径。
序号②指定动态SQL Mapper文件的路径。
序号③为基础的baseDAO Bean的声明。
a包类文件,主资源文件;测试Java包类文件,测试资源文件四大部分组成。
主Java包类文件的文件路径为com.ouc.mkhl.supplier,下按模块划分,示例中为jmx、security和util 3个模块。security模块又细分为advice包、dao数据访问对象包、domain包、model数据实体类包和service服务接口包,service服务接口包下包含impl服务接口实现包。
主资源文件包含email邮箱模板文件、logs日志配置文件、mybatis配置文件、spring相关配置文件。之后将对各配置文件做逐一介绍。
测试Java包类文件包含与主Java包相关的各单元测试文件。
测试资源文件包含springcache文件和mybatis数据持久层generator配置文件。
1) biz工程的pom配置文件:如下图所示:
序号①为工程的父maven工程配置。
序号②为工程的继承和引用工程关系配置。
2) biz工程主资源配置文件说明:
(1) mybatis配置文件:首先介绍基本的SQLMap配置文:sqlMapConfig.xml
按模块划分的动态SQLMapper文件:示例:SamStateInfoMapper.xml,如下图
(2) spring相关配置文件:
① 缓存cache配置文件:ehcache.xml,spring-cache-security.xml,spring-cache.xml。
② jmx运行期系统管理配置文件:spring-jmx-mbean.xml。
③ 按模块划分的自定义Bean声明配置文件:示例:spring-upload.xml
序号①为类似DAO的数据库接口操作类Bean。
序号②为服务接口Bean方法。
b为声明的切面,a为前置通知和后置通知要执行的方法。
④ 公用操作的配置文件spring-common.xml。
序号①指定mybatis基本配置文件sqlMapConfig.xml的路径。
序号②指定动态SQL Mapper文件的路径。
序号③为基础的baseDAO Bean的声明。
⑤ spring配置工具配置:spring-config-toolkit.xml
⑥ 数据源配置:spring-datasource.xml
⑦ Dubbo服务接口发布配置:spring-dubbo.xml
⑧ 服务扩展接口配置:spring-external.xml
⑨ 业务日志配置:spring-log.xml
⑩ Quartz监控配置:spring-monitor.xml
传输事物管理配置:spring-transaction.xml
biz工程代码示例:
用户暴露系统相关管理接口,以实现运行期调用:ExposeMethodInterface
运行期管理系统接口实现:Configuration
b.系统初始化:SystemBootstrap
package com.ouc.mkhl.supplier.util;
import java.io.IOException;
import java.io.InputStream;
import java.util.Properties;
import mx4j.tools.adaptor.http.HttpAdaptor;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;
import org.springframework.beans.factory.InitializingBean;
import org.springframework.core.env.AbstractEnvironment;
import com.ouc.openplatform.SysException;
import com.ouc.openplatform.console.audit.AuditInfoCollector;
import com.ouc.openplatform.session.listener.MaxSessionUtil;
import com.ouc.openplatform.util.Env;
import com.ouc.openplatform.util.HOPConstant; /**
* @author WuPing
*/
public class SystemBootstrap implements InitializingBean {
/*
* CONFIG_FILE_PATH 系统变量配置文件路径
*/
private static final String CONFIG_FILE_PATH = "/env.properties";
private static final Log LOG = LogFactory.getLog(SystemBootstrap.class);
private HttpAdaptor httpAdaptor;
public static void init() {
InputStream inputStream = null;
Properties properties = new Properties();
try{
inputStream SystemBootstrap.class.getResourceAsStream(CONFIG_FILE_PATH);
properties.load(inputStream);
LOG.info("系统配置项:"+properties);
}catch (Exception e) {
LOG.error("读取系统配置文件时发生错误:",e);
throw new SysException(e);
}finally{
if(inputStream != null){
try {
inputStream.close();
} catch (IOException e) {
LOG.error("关闭文件输入流失败:",e);
}
}
}
Env.init(properties);
AuditInfoCollector.setAppNM(Env.getProperty(Env.KEY_SERVER_NAME));
HOPConstant.setAppName(Env.getProperty(Env.KEY_SERVER_NAME));
//设置一些全局参数
MaxSessionUtil.setMaxSessionKey(Env.getProperty(Env.KEY_SERVER_NAME)+"_MAX_SESSION_KEYS");
//使用spring的profile
System.setProperty(AbstractEnvironment.ACTIVE_PROFILES_PROPERTY_NAME, Env.getProperty(Env.ENV_TYPE));
} @Override
public void afterPropertiesSet() throws Exception {
httpAdaptor.start();
} public void setHttpAdaptor(HttpAdaptor httpAdaptor) {
this.httpAdaptor = httpAdaptor;
}
}
c.DAO:SupplyUserDAO:
package com.ouc.mkhl.supplier.security.dao;
import java.util.List;
import com.ouc.mkhl.supplier.security.model.SupplyUser;
public interface SupplyUserDAO {
public int deleteByPrimaryKey(String supplycode);
public int insert(SupplyUser record);
public SupplyUser selectByPrimaryKey(String supplycode);
public int updateByPrimaryKey(SupplyUser record);
public List<SupplyUser> selectAllSupplyUser();
public SupplyUser selectByVCode(String supplycode);
}
d. Model:SupplyUser
package com.ouc.mkhl.supplier.security.model; import java.io.Serializable; public class SupplyUser implements Serializable{ private static final long serialVersionUID = -123120032141L; private String supplycode; private String supplypass; private String supplyname; public String getSupplycode() {
return supplycode;
} public void setSupplycode(String supplycode) {
this.supplycode = supplycode == null ? null : supplycode.trim();
} public String getSupplypass() {
return supplypass;
} public void setSupplypass(String supplypass) {
this.supplypass = supplypass == null ? null : supplypass.trim();
} public String getSupplyname() {
return supplyname;
} public void setSupplyname(String supplyname) {
this.supplyname = supplyname == null ? null : supplyname.trim();
}
}
1.3 service-client服务接口工程
service-client工程结构如图:
分为传输DTO包,辅助功能helper包,客户端服务接口声明service包和客户端工具类util包。
service-client示例代码:
a. DTO:SupplyUserDTO
package com.ouc.mkhl.supplier.dto; import java.io.Serializable; import com.ouc.openapi.dubbo.governance.annotation.DubboField; public class SupplyUserDTO implements Serializable{ private static final long serialVersionUID = -223120032141L; @DubboField(description = "供应商V码")
private String supplycode; @DubboField(description = "供应商登录密码-未加密")
private String supplypass; @DubboField(description = "供应商全称")
private String supplyname; public String getSupplycode() {
return supplycode;
} public void setSupplycode(String supplycode) {
this.supplycode = supplycode == null ? null : supplycode.trim();
} public String getSupplypass() {
return supplypass;
} public void setSupplypass(String supplypass) {
this.supplypass = supplypass == null ? null : supplypass.trim();
} public String getSupplyname() {
return supplyname;
} public void setSupplyname(String supplyname) {
this.supplyname = supplyname == null ? null : supplyname.trim();
}
}
package com.ouc.mkhl.supplier.service; import io.*.pampas.client.Export; import com.ouc.openapi.dubbo.governance.annotation.DubboMethod;
import com.ouc.openapi.dubbo.governance.annotation.DubboParam;
import com.ouc.openapi.dubbo.governance.annotation.DubboService;
import com.ouc.mkhl.supplier.dto.SupplyUserDTO; import java.util.List; /**
* 供客户端调用的远程接口
*
* @author WuPing
*
*/
@DubboService(description = "供应商用户服务", displayName = "SupplyUser服务")
public interface SupplyUserServiceClient { // get请求
// @return List<SupplyUserDTO>
@Export(paramNames = {})
@DubboMethod(description = "获取所有供应商用户信息", displayName = "getAllSupplyUsers", returnParamDes = "供应商用户DTO列表")
public List<SupplyUserDTO> getAllSupplyUsers(); // 用户登录处理
@Export(paramNames = { "username", "password" })
@DubboMethod(description = "用户登录验证", displayName = "userLogin", returnParamDes = "验证结果")
public String userLogin(
@DubboParam(name = "username", description = "登录用户名", example = "V187") String username,
@DubboParam(name = "password", description = "密码", example = "123456") String password); }
1.4 service-impl服务接口具体实现功能工程
Service-impl工程结构如图:
该工程包括异常处理filter包和客户端服务接口具体实现impl包。主资源文件有客户端Dubbo接口发布基本配置文件spring-dubbo.xml和用户自定义服务配置文件spring-user-provider.xml。如下图所示:
序号①为代理平台分配的应用S码。
序号②为后台接口代理服务。
序号③为服务方法认证相关服务接口。
序号④为服务自动注册接口。
Service-impl示例代码:
package com.ouc.mkhl.supplier.service.impl; import java.util.ArrayList;
import java.util.List; import javax.annotation.Resource;
import javax.ws.rs.BeanParam;
import javax.ws.rs.Consumes;
import javax.ws.rs.DefaultValue;
import javax.ws.rs.FormParam;
import javax.ws.rs.GET;
import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.QueryParam;
import javax.ws.rs.core.MediaType; import org.springframework.stereotype.Service; import com.alibaba.dubbo.rpc.protocol.rest.support.ContentType;
import com.ouc.openapi.dubbo.governance.annotation.DubboParam;
import com.ouc.mkhl.supplier.dto.SupplyUserDTO;
import com.ouc.mkhl.supplier.service.SupplyUserServiceClient;
import com.ouc.mkhl.supplier.security.service.SupplyUserService;
import com.ouc.mkhl.supplier.security.model.SupplyUser;
import com.ouc.mkhl.supplier.helper.EncryptHelper; @Path("supplyUser")
@Consumes({ ContentType.APPLICATION_JSON_UTF_8, ContentType.TEXT_XML_UTF_8 })
// 参数类型
@Produces({ ContentType.APPLICATION_JSON_UTF_8, ContentType.TEXT_XML_UTF_8 })
// 返回值类型
@Service("supplyUserServiceClient")
public class SupplyUserServiceClientImpl implements SupplyUserServiceClient { @Resource
private SupplyUserService supplyUserService; public SupplyUserService getSupplyUserService() {
return supplyUserService;
}
public void setSupplyUserService(SupplyUserService supplyUserService) {
this.supplyUserService = supplyUserService;
} @GET
@Path("getAllSupplyUser")
@Override
public List<SupplyUserDTO> getAllSupplyUsers() { List<SupplyUserDTO> supplyUserDTOList = new ArrayList<SupplyUserDTO>(); List<SupplyUser> supplyUserList = supplyUserService.getAllSupplyUser();
for (int i = 0; i < supplyUserList.size(); i++) {
SupplyUserDTO tempSupplyUserDTO = new SupplyUserDTO();
tempSupplyUserDTO.setSupplycode(supplyUserList.get(i)
.getSupplycode());
tempSupplyUserDTO.setSupplypass(supplyUserList.get(i)
.getSupplypass());
tempSupplyUserDTO.setSupplyname(supplyUserList.get(i)
.getSupplyname());
supplyUserDTOList.add(tempSupplyUserDTO);
} return supplyUserDTOList;
} @SuppressWarnings({ "unused" })
@GET
@Path("getUserByIdAndName")
@Override
public String userLogin(
@DefaultValue("V187") @QueryParam("username") String username,
@DefaultValue("123456") @QueryParam("password") String password) {
System.out.println("当前登录用户:" + username);
String md5Pass = ""; // MD5处理过的密码 // 设置登录反馈信息变量:1—成功;2—用户名不存在;3—密码无效登录失败。
String msg = null; EncryptHelper md5Helper = new EncryptHelper(); // 应用本地库
SupplyUser suppUser = new SupplyUser(); try {
suppUser = supplyUserService.getSupplyUserByVCode(username);
} catch (Exception e) {
suppUser = null;
e.printStackTrace();
} if (suppUser == null) {
suppUser = new SupplyUser();
if (username.equals("suptest")){
suppUser.setSupplycode("V187");
suppUser.setSupplyname("供应商端测试");
suppUser.setSupplypass("123456");
}
else if(username.equals("ouctest")) {
suppUser.setSupplycode("ouctest");
suppUser.setSupplyname("ouc端测试");
suppUser.setSupplypass("123456");
}
} else {
try {
md5Pass = md5Helper.md5Encode(password).toUpperCase();
} catch (Exception e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
System.out.println("MD5后的密码:" + md5Pass);
password = md5Pass;
} // 反馈信息设置
if (suppUser == null) {
msg = "2"; // 用户名不存在
} else {
if (suppUser.getSupplypass().equals(password)) {
if (suppUser.getSupplycode().equals("haiertest")){
//msg = "1"; //ouc端用户登录
msg = "ouc"; //ouc端
}
else {
//msg = "0"; //供应商端用户登录
msg = suppUser.getSupplycode(); //供应商端V码
}
} else {
msg = "3";// 密码无效
}
}
return msg;
} }
1.5 task任务调度工程
配置文件示例spring-lts-job.xml:如图1-35所示。
序号①为设置作业执行周期。
2. 桥梁辅助控制
包括控制controller、辅助类domain、excel处理、环境配置过滤器filter、操作拦截器interceptor、辅助工具utils等。
资源文件有:spring接口和代理服务配置文件root-context.xml、网页servlet拦截器配置文件servlet-context.xml、redis配置文件redis-persistence-context.xml。 项目环境配置文件filter,网页web.xml配置文件。
1) 项目环境配置文件filter:dev.properties,如下图所示。
序号①为项目环境类别说明。
序号②为日志配置。
序号③为项目验证url地址。
序号④为redis相关配置。
序号⑤为dubbo相关配置。
序号⑥为项目*仓库地址配置。
序号⑦为集群平台terracotta配置。
★序号⑧为与页面工程相关的配置:
应用简称(app.name),服务器名称(server.name),与页面工程有关的服务Key(server.key),dubbo应用名(dubbo.application.name),页面工程路径(publicPathPrefix),浏览器访问域名(domain.name)和默认跳转页面(login.after.jump.url)。
序号⑨为项目集团内网和外网环境安全配置。
2) Web.xml配置文件:
主要内容有配置系统启动监听器startupListeners,基于缓存实现的集群session配置和编码过滤等内容。
3. 前台页面工程
1) 页面工程结构如下.
典型的被linner管理的项目前端工程结构如下:
├─a: app ##app是开发者自开发代码的存储目录.
│ ├─a1: components ##存放项目的组件文件.
│ │ └─ dropdown ##示例组件(此处假设为dropdown).
│ │ └─ templates ##组件自身的前端模板.
│ │ ├─ view.coffee | view.js ##组件js,可以使coffee也可以是js.
│ │ ├─view.hbs ##组件模板
│ │ └─ view.scss | view.css ##组件样式文件,可以是scss,也可以是css.
│ ├─ a3: images ##存放项目相关的图片文件.
│ │ └── logo.png
│ ├─ a5: scripts ##存放项目相关的JavaScript文件.
│ │ └── app.coffee
│ ├─ a6: styles ##存放项目相关的StyleSheet文件.
│ │ └── app.scss
│ ├─ a7: templates ##存放项目相关的前端模板文件.
│ │ └── welcome.hbs
│ ├─ a8: views ##用于存放项目相关的页面文件.
│ │ └──index.html
│ └─ a2: files ##用于存放相关配置文件,例如front_config.yaml等.
├─bin ##用户可基于此启动本地服务器(以当前文件夹为根),当然更好的选择是适用jigglepuff来启动一个带渲染逻辑的服务器.
│ └── server.
├─config.yml ##是整个项目的配置文件.
├─ b: public ##是项目执行linner build后生成的打包文件位置,是发布项目所需要的所有文件.
├── test ##测试前端项目的单元测试文件所在目录.
└─ c: vendor ##存放引入的第三方代码组件,例如jQuery、Underscore等.
2) 页面调用后台服务
3) 整个项目的配置文件config.yml。
4) 后端服务back_config.yaml配置:
5) 前端页面引用服务front_config.yaml配置:
6) 页面hbs示例:
组件类型调用服务示例
ajax类型服务调用方式
友情链接:
handlebars官网:http://handlebarsjs.com/
Node.js官网:https://nodejs.org/en/
CoffeeScript 中文网:http://coffee-script.org/#top
Redis中文官网:http://www.redis.cn/
附件
A.LTS轻任务调度框架介绍:
• LTS框架概况:
LTS是一个轻任务调度框架,参考hadoop的部分思想。有三种角色, JobClient, JobTracker,TaskTracker。各个节点都是无状态的,可以部署多个,来实现负载均衡,实现更大的负载量, 并且框架具有很好的容错能力。 采用Zookeeper暴露节点信息,master选举。Mongo存储任务队列和任务执行日志, netty做底层通信。
▶ JobClient : 主要负责提交任务, 和接收任务执行反馈结果。
▶ JobTracker : 负责接收并分配任务,任务调度。
▶ TaskTracker: 负责执行任务,执行完反馈给JobTracker。
• 架构图:
• 节点组:
▶ 一个节点组等同于一个集群,同一个节点组中的各个节点是对等的,外界无论连接节点组中的任务一个节点都是可以的。
▶ 每个节点组中都有一个master节点,采用zookeeper进行master选举(master宕机,会自动选举出新的master节点),框架会提供接口API来监听master节点的变化,用户可以自己使用master节点做自己想做的事情。
▶ JobClient和TaskTracker都可以存在多个节点组。譬如JobClient 可以存在多个节点组。譬如:JobClient 节点组为‘QN_WEB’中的一个节点提交提交一个只有节点组为‘QN_TRADE’的TaskTracker 才能执行的任务。
▶ (每个集群中)JobTacker只有一个节点组。
▶ 多个JobClient节点组和多个TaskTracker节点组再加上一个JobTacker节点组, 组成一个大的集群。
• 工作流程:
▶ JobClient提交一个任务给 JobTracker, 这里我提供了两种客户端API, 一种是如果JobTracker 不存在或者提交失败,直接返回提交失败。另一种客户端是重试客户端, 如果提交失败,先存储文件,返回给客户端提交成功的信息,待JobTracker可用的时候,再将任务提交。
▶ JobTracker收到JobClient提交来的任务,先生成一个唯一的JobID。然后将任务储存在Mongo集群中。JobTracker 发现有(任务执行的)可用的TaskTracker节点(组)之后,将优先级最大,最先提交的任务分发给TaskTracker。这里JobTracker会优先分配给比较空闲的TaskTracker节点,达到负载均衡。
▶ TaskTracker收到JobTracker分发来的任务之后,执行。执行完毕之后,再反馈任务执行结果给JobTracker(成功or 失败[失败有失败错误信息]),如果发现JobTacker不可用,那么存储文件,等待TaskTracker可用的时候再反馈。反馈结果的同时,询问 JobTacker有没有新的任务要执行。
▶ JobTacker收到TaskTracker节点的任务结果信息,生成并插入(mongo)任务执行日志。根据任务信息决定要不要反馈给客户端。不需要反馈的直接删除, 需要反馈的(同样JobClient不可用存储文件,等待可用重发)。
▶ JobClient收到任务执行结果,进行自己想要的逻辑处理。
• 特性
▶ 负载均衡:
▷ JobClient和 TaskTracker会随机连接JobTracker节点组中的一个节点,实现JobTracker负载均衡。当连接上后,将一直保持连接这个节点,保持连接通道,知道这个节点不可用,减少每次都重新连接一个节点带来的性能开销。
▷ JobTracker分发任务时,是优先分配给最空间的一个TaskTracker节点,实现TaskTracker节点的负载均衡。
▶ 健壮性:
▷ 当节点组中的一个节点当机之后,自动转到其他节点工作。当整个节点组当机之后,将会采用存储文件的方式,待节点组可用的时候进行重发。
▷ 当执行任务的TaskTracker节点当机之后,JobTracker会将这个TaskTracker上的未完成的任务(死任务),重新分配给节点组中其他节点执行。
▶ 伸缩性:
因为各个节点都是无状态的,可以动态增加机器部署实例, 节点关注者会自动发现。
• 调用示例
安装 zookeeper 和 mongo , 执行 data/mongo目录下的 mongo.md 中的语句见 job-example 这里给出的是java API(设置配置)方式启动,也可以使用配置文件中。
▶ JobTracker端
▶ JobClient端
▶ TaskTracker端