JBoss.orgCommunity Documentation

第 2 章 应用包结构

2.1. 应用包结构
2.2. 应用项目拓扑结构说明

通过第一部分(新手指南)的介绍我们已经完整的创建了一个应用并启动起来了。这一部分我们将对整个应用的包结构进行讲解。

技术框架基于Spring (3.1.4.RELEASE) 、 MyBatis( 3.1.1)组合
			 

应用详细结构说明,如下图

应用项目结构配置说明

一、src/main/java文件夹下为项目的主要源代码目录,其包结构简要说明如下:
1.	com.epicsaas.app.xxx.dao   DAO层包(Mybatis Mappers) 
2.	com.epicsaas.app.xxx.appobject   应用对象层包
3.	com.epicsaas.app.xxx.entity 实体层包
4.	com.epicsaas.app.xxx.service 服务层包
5.	com.epicsaas.app.xxx.controller WEB层包
6.	Com.epicsaas.app.xxx..util 工具类包
其中,dao、entity 下面会使用代码生成程序生成 gen 包,分别存放生成的数据存取对象和实体。

二、src/main/resources文件夹下为项目的主要配置目录,其包结构简要说明如下:
1./com/epicsaas/app/xxx/dao/gen  Mybatis自动生成的Mapper.xml文件
2./com/epicsaas/app/xxx/dao/gen/{dbtype}  Mybatis自动生成的Mapper.xml文件各数据库版备份,
用于多数据库切换. 执行Mybatis生成工具会自动生成 例如mysql则com.epicsaas.app.xxx.dao.gen.mysql
3./etc Maven插件执行时需要的配置文件。  
4./validation/ Spring实体验证配置文件,如需要请自行添加
5./env.properties 开发环境相关配置文件。包括数据库与注册中心配置
6./generatorConfig-{dbtype}.xml  Mybatis自动生成插件配置文件。生成插件默认为mysql版。
7./log4j.xml  日志配置文件
8./ saasIntegrate.json 项目集成信息配置
集成配置详细说明:
a)mainUrl 从集成应用跳转到该应用的主入口地址。
b)widgetUrl 应用需要接入到集成应用的部件入口地址。如果没有可以不配置
 (1) 部件接入部分不是iframe接入,而是嵌套该地址返回html片段。
 请编写内联样式并且样式作用范围不能超出该部件。即需要编写时在应用ID下,避免和集成界面重复。
(2)部件大小为329px * 215px
c)quickUrl 快速进入某个应用功能的入口。
 例如:  假设有http://ip:port/appfw/pc/main/create 来快速打开发文表单,该处的配置为
 "quickUrl": {"发文起草": " /appfw/pc/main/create "  }
d)openUrl 快速进入某条办理数据。办理数据包括(我发起的、我关注的、我办理的、我为办理的)。
 (1) 用户登陆集成应用会有办理数据列表,该列表被点击时,点击事件会取该数据中的{dataType},{dataId}
 字段信息来拼接成URL入口并打开。
(2) 办理数据结构请参看办理API文档
(3)URL格式为 http://ip:port/{appName} /{subname}/{dataId}
例如:假设有http://ip:port/appfw/pc/main/open/1000来快速打开发文类型为appfw的业务数据
ID为1000的表单办理数据。 其配置为:"openUrl": {"appfw": "/appfw/pc/main/open",  }
e)iconUrl 应用图标地址
	iconSmall:小图标地址。大小为 29px * 29px。置于集成应用中
	iconMiddle:中图标地址。大小57px * 57px  置于应用中心展示
	iconBig:大图标地址 114px * 114px。置于应用中心展示

三、src/test/java文件夹下为项目的主要测试代码目录

四、src/test/resources文件夹下为项目的主要测试配置目录

五、src/main/webap文件夹下为项目的主要渲染文件目录,其包结构说明如下:
1./META-INF/  项目的META-INF文件目录
2./static/        项目的静态文件存放目录(请务必存放,便于资源加速)
3./WEB-INF/
 |--mvcViews/  模板文件存放地址,默认支持IE9版本
 |--spring/	   spring配置文件目录
 |--ssb/ 		系统总线配置文件目录(如需使用服务请配置ssbConsumer.xml)。
 |--web.xml      应用配置文件

六、sql文件夹为项目数据库脚步存放目录
 /sql/
  |--mariadb/x.x.x-x.x.x.sql(0.0.0-0.0.1.sql为初始化后的文件)
对应用升级时注意:如果应用升级需要执行sql,请把sql放于该文件中。
例如当前平台上运行版本为0.0.3,要升级到0.0.6,则sql的命令写法为0.0.3-0.0.6.sql
			      
七、target文件夹下为项目的操作输出文件目录
执行 mvn clean install 对项目进行打包后在其目录下会生成{appName}-{version}.zip