Skip to content

H
hel-developer-guide
Commit b88e3a1f authored by zydgitboox's avatar zydgitboox
Browse files
Options

Track 16 files into repository. 

- untracked assets/mvn_archetype_plugin.png
- modified codeStyle.md
- modified git-guide.md
- modified liquibase-use.md
- modified project-create.md
- removed 前端组件/grid.md
- modified 前端组件/hlsDataSource.md
- modified 前端组件/hlsDatePicker.md
- untracked 前端组件/hlsGrid.md
- modified 前端组件/hlsMaskedTextBox.md
- modified 前端组件/hlsPage.md
- modified 前端组件/hlsTlEdit.md
- untracked 后端开发/database-config.md
- untracked 后端开发/database-init.md
- modified 框架功能描述/jad.md
- modified 融租易开发手册.md

Auto commit by GitBook Editor
parent a0edb5e8
Expand all Hide whitespace changes
Inline Side-by-side
Showing with 1300 additions and 974 deletions
codeStyle.md
View file @ b88e3a1f
This diff is collapsed.
git-guide.md
View file @ b88e3a1f
This diff is collapsed.
liquibase-use.md
View file @ b88e3a1f
This diff is collapsed.
project-create.md
View file @ b88e3a1f
This diff is collapsed.
前端组件/hlsDataSource.md
View file @ b88e3a1f
# hlsDataSource标签
数据源组件hlsDataSource
```
<h:hlsDataSource id="hlsDataSource" autoQuery="true" successEnd="successEnd">
<h:transport parameter="parameter">
<h:read url="" type="GET" />
</h:transport>
</h:hlsDataSource>
```
| **属性** | **参数** | **说明** |
| -------- | -------- | -------- |
| id | 唯一英文标识 | 数据源唯一标志，返回数据源对象，包含查询返回的数据 |
| autoQuery | true/false | 自动查询标志，默认为true，true代表自动发送查询请求，false代表不发送查询请求 |
| successEnd | function | 异步请求成功的回调函数，参数:data\(查询返回的数据\) |
| parameter | function | 函数返回一个对象，会自动封装到查询条件中 |
| url | 查询字符串 | 查询字符串，对应后台的数据接口 |
| type | GET/POST | 对应发送GET请求跟POST请求 |
# hlsDataSource标签（数据源控件）
数据源组件hlsDataSource
```
<h:hlsDataSource id="hlsDataSource" autoQuery="true" successEnd="successEnd">
<h:transport parameter="parameter">
<h:read url="" type="GET" />
</h:transport>
</h:hlsDataSource>
```
| **属性** | **参数** | **说明** |
| -------- | -------- | -------- |
| id | 唯一英文标识 | 数据源唯一标志，返回数据源对象，包含查询返回的数据 |
| autoQuery | true/false | 自动查询标志，默认为true，true代表自动发送查询请求，false代表不发送查询请求 |
| successEnd | function | 异步请求成功的回调函数，参数:data\(查询返回的数据\) |
| parameter | function | 函数返回一个对象，会自动封装到查询条件中 |
| url | 查询字符串 | 查询字符串，对应后台的数据接口 |
| type | GET/POST | 对应发送GET请求跟POST请求 |
前端组件/hlsDatePicker.md
View file @ b88e3a1f
# hlsDatePicker标签
# hlsDatePicker标签（时间控件）
日期选择器(不包含时分秒)
......
前端组件/hlsMaskedTextBox.md
View file @ b88e3a1f
## hlsMaskedTextBox（文本框）
格式框
##### xml配置
```xml
<!--h:为命名空间,必须要加的;maskedTextBox为组件名;id可写可不写-->
<h:hlsMaskedTextBox id="hlsMaskedTextBox"/>
```
#### **一般属性**
> **提示:**
>
> * 属性用法请参考kendoui API文档的maskedTextBox:[http:\/\/docs.telerik.com\/kendo-ui\/api\/javascript\/ui\/maskedtextbox](http://docs.telerik.com/kendo-ui/api/javascript/ui/maskedtextbox)
| 属性名 | 类型 | 说明 |
| --- | --- | --- |
| id | String | 唯一英文标识 |
| promptColspan | number | 该数字将会与col-sm-？进行拼接，替代问号，生成对应bootstrap的css样式，渲染描述的样式 |
| promptClassName | String | 描述的样式名称，会将对应的样式添加到描述中 |
| promptImage | String | 描述前面的一个文本图像，在设置为必填的时候会出现一个红色的* |
| prompt | String | 中文描述 || colspan| number | 该数字会与col-sm-?进行拼接，替代问号，生成对应bootStrap的css样式，渲染文本框的样式 |
| hlsClassName | String | 标签的样式名称 |
| placeholder | String | 占位符 |
| bind | expressions | 绑定数据 |
用法示例：
```xml
<h:hlsMaskedTextBox id="hlsMaskedTextBox" required="true" placeholder="hlsMaskedTextBox" />
```
> **提示:**
>
> * 上述所有属性直接添加在标签内即可，（**\[\*\***属性名\]**\*\* = "..."**）
#### **子标签**
| 属性名 | 类型 |
| --- | --- |
| rules | Object |
```javascript
function rules(){
//...
}
```
```xml
<h:hlsMaskedTextBox id="hlsMaskedtTextBox" placeholder="hlsMaskedTextBox" prompt="hlsMaskedTextBox"
bind="model" bind="enabled: isEnabled, value:data.textBox">
</h:hlsMaskedTextBox>
```
> **提示**：
>
> * 遇到**object**类型 就向下添加子标签，当遇到普通类型时，就添加到当前的标签上。
## hlsMaskedTextBox（文本框）
格式框
##### xml配置
```xml
<!--h:为命名空间,必须要加的;maskedTextBox为组件名;id可写可不写-->
<h:hlsMaskedTextBox id="hlsMaskedTextBox"/>
```
#### **一般属性**
> **提示:**
>
> * 属性用法请参考kendoui API文档的maskedTextBox:[http:\/\/docs.telerik.com\/kendo-ui\/api\/javascript\/ui\/maskedtextbox](http://docs.telerik.com/kendo-ui/api/javascript/ui/maskedtextbox)
| 属性名 | 类型 | 说明 |
| --- | --- | --- |
| id | String | 唯一英文标识 |
| promptColspan | number | 该数字将会与col-sm-？进行拼接，替代问号，生成对应bootstrap的css样式，渲染描述的样式 |
| promptClassName | String | 描述的样式名称，会将对应的样式添加到描述中 |
| promptImage | String | 描述前面的一个文本图像，在设置为必填的时候会出现一个红色的* |
| prompt | String | 中文描述 || colspan| number | 该数字会与col-sm-?进行拼接，替代问号，生成对应bootStrap的css样式，渲染文本框的样式 |
| hlsClassName | String | 标签的样式名称 |
| placeholder | String | 占位符 |
| bind | expressions | 绑定数据 |
用法示例：
```xml
<h:hlsMaskedTextBox id="hlsMaskedTextBox" required="true" placeholder="hlsMaskedTextBox" />
```
> **提示:**
>
> * 上述所有属性直接添加在标签内即可，（**\[\*\***属性名\]**\*\* = "..."**）
#### **子标签**
| 属性名 | 类型 |
| --- | --- |
| rules | Object |
```javascript
function rules(){
//...
}
```
```xml
<h:hlsMaskedTextBox id="hlsMaskedtTextBox" name="hlsMaskedtTextBox" placeholder="hlsMaskedTextBox" prompt="hlsMaskedTextBox"
bind="enabled: isEnabled, value:data.hlsMaskedtTextBox">
</h:hlsMaskedTextBox>
```
> **提示**：
>
> * 遇到**object**类型 就向下添加子标签，当遇到普通类型时，就添加到当前的标签上。
前端组件/hlsPage.md
View file @ b88e3a1f
# hlsPage
代码示例
```xml
<h:hlsPage dataSource="pageDataSource" pageSize="3" titleSearchId="search" inputPlaceholder="项目信息" titleSearchInputId="searchId" id="pageFirst" titleImg="${contextPath!}/resources/images/CONT/contract.png" title="项目">
<h:columns>
<h:column field="divisionDesc" title='<@spring.message "业务模式"/>' >
</h:column>
<h:column field="projectStatusDesc" title='<@spring.message "审批状态"/>'>
</h:column>
<h:column field="tenantName" title='<@spring.message "承租人"/>' >
</h:column>
<h:column field="systemFlag" title='<@spring.message "系统级"/>' template="fn:businessTypeTemplate">
</h:column>
</h:columns>
</h:hlsPage>
```
属性说明
| **属性** | **参数** | **说明** |
| -------- | -------- | -------- |
| id | 唯一标志id | 返回一个名为id的分页对象 |
| dataSource | object | 数据源对象,参考标签hlsPageDataSource |
| pageSize | number | 每页的分页数量，可设置每页显示数据条数 |
| titleSearchId | 唯一标志id | 分页标签title查询框的id，可通过改标志获取数据或其它操作 |
| inputPlaceholder | text | 查询框的提示信息 |
| titleSearchInputId | 唯一标志id | 查询图片的标准id |
| titleImg | String | 标题栏的图片路劲 |
| title | String | 标题栏名称 |
| field | String | 字段的英文标注 |
| title(2) | String | 字段的中文标注 |
# hlsPage（分页控件）
代码示例
```xml
<h:hlsPage dataSource="pageDataSource" pageSize="3" titleSearchId="search" inputPlaceholder="项目信息" titleSearchInputId="searchId" id="pageFirst" titleImg="${contextPath!}/resources/images/CONT/contract.png" title="项目">
<h:columns>
<h:column field="divisionDesc" title='<@spring.message "业务模式"/>' >
</h:column>
<h:column field="projectStatusDesc" title='<@spring.message "审批状态"/>'>
</h:column>
<h:column field="tenantName" title='<@spring.message "承租人"/>' >
</h:column>
<h:column field="systemFlag" title='<@spring.message "系统级"/>' template="fn:businessTypeTemplate">
</h:column>
</h:columns>
</h:hlsPage>
```
属性说明
| **属性** | **参数** | **说明** |
| -------- | -------- | -------- |
| id | 唯一标志id | 返回一个名为id的分页对象 |
| dataSource | object | 数据源对象,参考标签hlsPageDataSource |
| pageSize | number | 每页的分页数量，可设置每页显示数据条数 |
| titleSearchId | 唯一标志id | 分页标签title查询框的id，可通过改标志获取数据或其它操作 |
| inputPlaceholder | text | 查询框的提示信息 |
| titleSearchInputId | 唯一标志id | 查询图片的标准id |
| titleImg | String | 标题栏的图片路劲 |
| title | String | 标题栏名称 |
| field | String | 字段的英文标注 |
| title(2) | String | 字段的中文标注 |
| template | function | 渲染函数，可将返回的html字符串渲染到对应的字段 |
\ No newline at end of file
前端组件/hlsTlEdit.md
View file @ b88e3a1f
## hlsTlEdit
多语言编辑
##### xml配置
```xml
<!--h:为命名空间,必须要加的;hlsTlEdit为组件名;id可写可不写-->
<h:hlsTlEdit id="hlsTlEdit"/>
```
#### **一般属性**
| 属性名 | 类型 | 说明 |
| --- | --- | --- |
| id | String | 唯一英文标识 |
| promptColspan | number | 该数字将会与col-sm-？进行拼接，替代问号，生成对应bootstrap的css样式，渲染描述的样式 |
| promptClassName | String | 描述的样式名称，会将对应的样式添加到描述中 |
| promptImage | String | 描述前面的一个文本图像，在设置为必填的时候会出现一个红色的* |
| prompt | String | 中文描述 |
| colspan| number | 该数字会与col-sm-?进行拼接，替代问号，生成对应bootStrap的css样式，渲染文本框的样式 |
| hlsClassName | String | 标签的样式名称 |
| placeholder | String | 占位符 |
| bind | expressions | 绑定数据 |
用法示例：
```xml
<h:hlsTlEdit id="tl" placeholder="多语言" bind="value:data.name" idField="id" field="name" dto="com.hand.hap.function.dto.Resource" model="viewModel.data">
</h:hlsTlEdit>
```
> **提示：**
>
> * 以上所有属性都直接可以添加到tlEdit标签上，用法皆为\[**属性名**\]="\[**属性值**\]"
## hlsTlEdit（多语言控件）
多语言编辑
##### xml配置
```xml
<!--h:为命名空间,必须要加的;hlsTlEdit为组件名;id可写可不写-->
<h:hlsTlEdit id="hlsTlEdit"/>
```
#### **一般属性**
| 属性名 | 类型 | 说明 |
| --- | --- | --- |
| id | String | 唯一英文标识 |
| promptColspan | number | 该数字将会与col-sm-？进行拼接，替代问号，生成对应bootstrap的css样式，渲染描述的样式 |
| promptClassName | String | 描述的样式名称，会将对应的样式添加到描述中 |
| promptImage | String | 描述前面的一个文本图像，在设置为必填的时候会出现一个红色的* |
| prompt | String | 中文描述 |
| colspan| number | 该数字会与col-sm-?进行拼接，替代问号，生成对应bootStrap的css样式，渲染文本框的样式 |
| hlsClassName | String | 标签的样式名称 |
| placeholder | String | 占位符 |
| bind | expressions | 绑定数据 |
用法示例：
```xml
<h:hlsTlEdit id="tl" placeholder="多语言" bind="value:data.name" idField="id" field="name" dto="com.hand.hap.function.dto.Resource" model="viewModel.data">
</h:hlsTlEdit>
```
> **提示：**
>
> * 以上所有属性都直接可以添加到tlEdit标签上，用法皆为\[**属性名**\]="\[**属性值**\]"
后端开发/database-config.md 0 → 100644
View file @ b88e3a1f
# Oracle,MySql,Sqlserver数据库配置
## 配置文件
1. 服务数据源配置
* 融租易默认使用 JNDI 来配置数据源。数据源的配置独立于项目配置
* 默认使用的 JNDI name 为 `jdbc/hel_dev`
* tomcat 需要配置 context.xml：
- Mysql
```
<Resource auth="Container" driverClassName="com.mysql.jdbc.Driver" url="jdbc:mysql://localhost:3306/hel" name="jdbc/hel_dev" type="javax.sql.DataSource" username="hel_dev" password="hel_dev"/>
```
- Oracle
```
<Resource auth="Container" driverClassName="oracle.jdbc.driver.OracleDriver" name="jdbc/hel_dev" type="javax.sql.DataSource" url="jdbc:oracle:thin:@127.0.0.1:1521:hel" username="hel_dev" password="hel_dev"/>
```
- SqlServer
```
<Resource auth="Container" driverClassName="com.microsoft.sqlserver.jdbc.SQLServerDriver" url="jdbc:sqlserver://127.0.0.1:1433; DatabaseName=hel" name="jdbc/hel_dev" type="javax.sql.DataSource" username="hel_dev" password="hel_dev"/>
```
* 其他[应用服务器weblogic](/框架功能描述/deployment.md)等，需要按其配置方法 配置 JNDI
2. 数据库数据源配置
> 融租易项目根目录的pom.xml中默认包含了 `Oracle`,`Mysql`,`SqlServer` 的 JDBC 驱动，一般不需要改动
* 修改 resources/config.properties
* 当数据库为 oracle 时
```
db.type=oracle
db.jndiName=java:comp/env/jdbc/hel_dev
mybatis.identity=SEQUENCE
```
* 当数据库为mysql时
```
db.type=mysql
db.jndiName=java:comp/env/jdbc/hel_dev
```
* 修改完毕后复制一份放到 resources/profiles/dev (覆盖)
3. redis服务配置
修改resources/config.properties：
* 配置单个redis的时候只需配置
```
redis.ip=172.20.0.115
redis.port=6379
redis.db=1
```
* 当配置redis集群时需配置
```
redis.useSentinel=true --为true时单个redis配置熟悉失效
redis.sentinel=\
10.86.20.183:26379,\
10.86.20.184:26379
```
后端开发/database-init.md 0 → 100644
View file @ b88e3a1f
# 新建数据库
# 1. 创建数据库-Mysql
> 在开始之前最好修改一下 MySQL的配置文件 my.cnf (or my.ini)
,在 [mysqld] 下添加
```
lower_case_table_names=1
character_set_server=utf8
max_connections=500
```
* 用管理员登陆mysql
* 创建数据库hel_dev
```sql
create schema hel_dev default character set utf8;
```
* 创建用户hel_dev,并将密码设置为hel_dev
```sql
CREATE USER hel_dev@'%' IDENTIFIED BY 'hel_dev';
CREATE USER hel_dev@'localhost' IDENTIFIED BY 'hel_dev';
```
* 将上面新建的hel_dev权限赋予用户hel
```sql
GRANT ALL PRIVILEGES ON hel_dev.* TO hel_dev@'%';
GRANT ALL PRIVILEGES ON hel_dev.* TO hel_dev@'localhost';
flush privileges;
```
# 2. 创建数据库-Oracle
* 使用管理员登陆
* 创建表空间
```sql
CREATE BIGFILE TABLESPACE tbs_perm_hel
DATAFILE 'tbs_perm_hel.dat'
SIZE 200M
AUTOEXTEND ON NEXT 20M MAXSIZE 500M;
```
```sql
CREATE TEMPORARY TABLESPACE tbs_temp_hel
TEMPFILE 'tbs_temp_hel.dbf'
SIZE 200M
AUTOEXTEND ON NEXT 20M MAXSIZE 500M;
```
* 创建用户 schema
```sql
CREATE USER hel_dev
IDENTIFIED BY hel_dev
DEFAULT TABLESPACE tbs_perm_hel
TEMPORARY TABLESPACE tbs_temp_hel
QUOTA 200M on tbs_perm_hel;
```
* 授权
```sql
GRANT create session TO hel_dev;
GRANT create table TO hel_dev;
GRANT create view TO hel_dev;
GRANT create any trigger TO hel_dev;
GRANT create any procedure TO hel_dev;
GRANT create sequence TO hel_dev;
GRANT create synonym TO hel_dev;
```
# 3. 创建数据库-sql server
* 使用管理员登陆
* 创建数据库
```sql
CREATE DATABASE hel_dev COLLATE Chinese_PRC_CI_AS;
```
* 创建用户 hel 并授权
```sql
sp_addlogin 'hel','hel_dev';
use hel_dev
go
sp_adduser 'hel_dev','hel_dev'
go
sp_addrolemember 'db_owner','hel'
go
```
\ No newline at end of file
框架功能描述/jad.md
View file @ b88e3a1f
## Excel文件导入
使用poi解析xml方式进行导入，只支持单表导入。
数据库批量导入默认batch为100.
支持多sheet导入，sheet1从第三行开始读取数据，其他sheet页从第一行导入数据。
使用方法：
1. Excel文件上传
```javascript
$("#files").kendoUpload({
async: {
saveUrl: "${base.contextPath}/hls/excel/import?${_csrf.parameterName}=${_csrf.token}&templateCode=HLS_FIN_STATEMENT_LN",
removeUrl: "remove"
},
showFileList: false,
upload: onUpload,
success: onSuccess
});
```
| 参数名 | 描述 |
| :--: | :--: |
| _csrf.token | 防跨域token |
| templateCode | 作为模块标识，会出现先在fnd_interface_header中，供后续业务逻辑进行处理 |
2. 处理数据
经过第一步的文件上传，后台会在fnd_interface_header表中生成一条数据，其中包含了传递的templateCode参数作为code，并且，在fnd_interface_lines表中按照顺序，将Excel文件中的每一行数据保存为一条数据，数据的第一列保存在attributes_1上，依次类推。
![ExcelImport](/assets/excelImport.png)
## Excel文件批量导出
本系统支持Excel文件导出排队处理，支持超大数据量，能实时查询文件生成情况，支持取消导出。
#### 前端使用方法
调用js方法
```javascript
Hel.exportExcel=function(opts){
var contextPath =opts.contextPath,
id=opts.id,
view_model=opts.viewModel,
viewModelData=opts.viewModelData,
controller_name = opts.controller,
fileName = opts.fileName,
temp_div_id=opts.tempDivId,
dataSourceId = opts.dataSourceId,
_csrf_token = opts._csrf_token;
```
| 参数名 | 描述 |
| :--: | :--: |
| contextPath | 项目的url路径 |
| id | 页面上grid的id |
| view_model | grid绑定的model数据模型 |
| viewModelData | model模型中的数据 |
| controller_name | 后端控制器名称 |
| fileName | excel文件名 |
| temp_div_id | 临时div的id |
| dataSourceId | 数据源id |
| _csrf_token | 防跨域的token |
#### 后端使用方法
1. 在代码中注入Excel导出Service
```java
@AutoWired
private ExcelExportServiceImpl excelService;
```
2. 在自己的controller中调用方法
```java
excelService.saveExportInfo(sqlId,iRequest,config,rowMaxNumber);
```
| 参数名 | 类型 | 描述 |
| :--: | :--: | :--: |
| sqlId | String | mybatis对应的数据库查询语句的ID |
| iRequest | IRequest | 带有上下文信息的reuqest对象 |
| config | ExportConfig | 包含Excel各列信息的对象，由前台传递json对象转换而来 |
| rowMaxNumber | int | 生成Excel的最大行数，可使用重载方法，不包含次参数默认为1,000,000 |
3. 运行Excel导出程序(获取该程序，请联系部门相关负责人)
```shell
java -jar hel-batch-parent.jar &
```
4. Excel导出情况查询
用户若是为管理员身份，则查询全部人的导出情况，否则只显示当前用户的导出数据
```java
excelService.queryExportInfo(status, iRequest);
```
| 参数名 | 类型 | 描述 |
| :--: | :--: | :--: |
| status | String | 指定Excel导出的状态，该参数可为空查询全部状态数据<br><ul><li>new->等待</li><li>generating->文件导出中</li><li>finished->导出完成</li><li>failed-> 导出失败</li></ul> |
| iRequest | IRequest | 带有上下文信息的reuqest对象 |
5. 下载已完成的Excel文件
```java
excel.downloadExcel(filePath, fileName, request, response);
```
| 参数名 | 类型 | 描述 |
| :--: | :--: | :--: |
| filePath | String | 需要下载的文件的路径 |
| fileName | String | 想要保存的文件的名称 |
| request | HttpServletRequest | 用户的请求对象 |
| response | HttpServletResponse | 用户的响应对象 |
## Excel文件导入
使用poi解析xml方式进行导入，只支持单表导入。
数据库批量导入默认batch为100.
支持多sheet导入，sheet1从第三行开始读取数据，其他sheet页从第一行导入数据。
使用方法：
1. Excel文件上传
```javascript
$("#files").kendoUpload({
async: {
saveUrl: "${base.contextPath}/hls/excel/import?${_csrf.parameterName}=${_csrf.token}&templateCode=HLS_FIN_STATEMENT_LN",
removeUrl: "remove"
},
showFileList: false,
upload: onUpload,
success: onSuccess
});
```
| 参数名 | 描述 |
| :--: | :--: |
| _csrf.token | 防跨域token |
| templateCode | 作为模块标识，会出现先在fnd_interface_header中，供后续业务逻辑进行处理 |
2. 处理数据
经过第一步的文件上传，后台会在fnd_interface_header表中生成一条数据，其中包含了传递的templateCode参数作为code，并且，在fnd_interface_lines表中按照顺序，将Excel文件中的每一行数据保存为一条数据，数据的第一列保存在attributes_1上，依次类推。
![ExcelImport](/assets/excelImport.png)
## Excel文件批量导出
本系统支持Excel文件导出排队处理，支持超大数据量，能实时查询文件生成情况，支持取消导出。
#### 前端使用方法
调用js方法
* 方法一（针对grid）
```javascript
Hel.exportExcel=function(opts){
var contextPath =opts.contextPath,
id=opts.id,
view_model=opts.viewModel,
viewModelData=opts.viewModelData,
controller_name = opts.controller,
fileName = opts.fileName,
temp_div_id=opts.tempDivId,
dataSourceId = opts.dataSourceId,
_csrf_token = opts._csrf_token;
```
| 参数名 | 描述 |
| :--: | :--: |
| contextPath | 项目的url路径 |
| id | 页面上grid的id |
| view_model | grid绑定的model数据模型 |
| viewModelData | model模型中的数据 |
| controller_name | 后端控制器名称 |
| fileName | excel文件名 |
| temp_div_id | 临时div的id |
| dataSourceId | 数据源id |
| _csrf_token | 防跨域的token |
* 方式二（针对hlsPage）
```javascript
Hel.exportPageExcel({
contextPath:basePath,
param:{},
controller:"/acr/inf/index/excel/export",
fileName:"产品线",
pageConfig:[
{"name":"documentNumber","title":"单据编 号","width":260,"align":"","type":"string"},
{"name":"invoiceDate","title":"开票日期","align":"","type":"string"},
{"name":"invoiceKindDesc","title":"发票种类","width":160,"align":"center","type":"boolean"},
{"name":"bpName","title":"购货单位"},
]
});
```
| 参数名 | 描述 |
| --- | --- |
| contextPath | 项目上的url |
| param| 配合controller添加查询条件 |
| controller | 对应查询url |
| fileName | 文件名 |
| pageConfig | 导出字段名称及样式|
#### 后端使用方法
1. 在代码中注入Excel导出Service
```java
@AutoWired
private ExcelExportServiceImpl excelService;
```
2. 在自己的controller中调用方法
```java
excelService.saveExportInfo(sqlId,iRequest,config,rowMaxNumber);
```
| 参数名 | 类型 | 描述 |
| :--: | :--: | :--: |
| sqlId | String | mybatis对应的数据库查询语句的ID |
| iRequest | IRequest | 带有上下文信息的reuqest对象 |
| config | ExportConfig | 包含Excel各列信息的对象，由前台传递json对象转换而来 |
| rowMaxNumber | int | 生成Excel的最大行数，可使用重载方法，不包含次参数默认为1,000,000 |
3. 运行Excel导出程序(获取该程序，请联系部门相关负责人)
```shell
java -jar hel-batch-parent.jar &
```
4. Excel导出情况查询
用户若是为管理员身份，则查询全部人的导出情况，否则只显示当前用户的导出数据
```java
excelService.queryExportInfo(status, iRequest);
```
| 参数名 | 类型 | 描述 |
| :--: | :--: | :--: |
| status | String | 指定Excel导出的状态，该参数可为空查询全部状态数据<br><ul><li>new->等待</li><li>generating->文件导出中</li><li>finished->导出完成</li><li>failed-> 导出失败</li></ul> |
| iRequest | IRequest | 带有上下文信息的reuqest对象 |
5. 下载已完成的Excel文件
```java
excel.downloadExcel(filePath, fileName, request, response);
```
| 参数名 | 类型 | 描述 |
| :--: | :--: | :--: |
| filePath | String | 需要下载的文件的路径 |
| fileName | String | 想要保存的文件的名称 |
| request | HttpServletRequest | 用户的请求对象 |
| response | HttpServletResponse | 用户的响应对象 |
**下载前，需要检查config.properties文件中的export.offerUrl配置项是否配置正确，且为hel-batch-parent.jar提供的文件下载url**
\ No newline at end of file
融租易开发手册.md
View file @ b88e3a1f
# 融租易开发手册
* [GitBook使用](/gitbook.md)
---
* I. 开发环境准备
* [1.1 Git 使用](/git-guide.md "git指令")
* [1.2 Maven 使用](/maven.md "maven使用")
* [1.3 开发环境搭建](/project-create.md)
* [1.4 更新项目的HEL依赖版本](/project-update.md)
* [1.5 Liquibase](/liquibase-use.md)
* II. 项目开发规范
* [2.1 项目开发规范](/codeStyle.md#backEndDev)
* [2.2 编码规范](/codeStyle.md#backEndName)
* 2.3 Checkstyle
* III. 后端开发
* [3.1 后端开发说明(1.0)](/后端开发/dev-flow.md)
* [3.2 用户安全策略](/后端开发/user-security-strategy.md)
* [3.3 审计](/后端开发/audit.md)
* [3.4 锁机制](/后端开发/lock.md)
* [3.5 日志管理](/后端开发/elk.md)
* [3.6 代码生成器](/后端开发/code-generator.md)
* [3.7 跨域访问](/后端开发/3.24-cors.md)
* IV. 前端JavaScript开发
* [4.1 前端开发说明 \(1.0\)](/front-kendoui.md)
* [4.2 字段级通用方法](/common-field-javascript.md)
* [4.3 窗口级通用方法](/common-window-javascript.md)
* [4.4 锁屏和解屏通用方法](/common-mask-javascript.md)
* V. 前端UI开发
* [5.1 hlsCombobox(下拉框)](/前端组件/hlsCombobox.md)
* [5.2 hlsDataSource](/前端组件/hlsDataSource.md)
* [5.3 hlsMaskedTextBox](/前端组件/hlsMaskedTextBox.md)
* [5.4 hlsPage](/前端组件/hlsPage.md)
* [5.5 hlsTextArea](/前端组件/hlsTextArea.md)
* [5.6 hlsTlEdit](/前端组件/hlsTlEdit.md)
* [5.7 hlsDatePicker(日期选择框)](/前端组件/hlsDatePicker.md)
* [5.8 hlsDateTimePicker(时间选择框)](/前端组件/HlsDateTimePicker.md)
* [5.9 hlsLov(lov选择框)](/前端组件/HlsLov.md)
* [5.10 hlsToolBar(底部菜单栏)](/前端组件/HlsToolBar.md)
* [5.11 TabStrip(sheet页切换卡)](/前端组件/TabStrip.md)
* [5.12 hlsForm(表单)](/前端组件/hlsForm.md)
* [5.13 hlsCombobox](/前端组件/HlsCombobox.md)
* [5.14 hlsCheckBox(复选框)](/前端组件/HlsCheckBox.md)
* [5.15 Grid](/前端组件/Grid.md)
* [5.16 DataSource](/前端组件/DataSource.md)
* [5.17 hlsGridBox](/前端组件/hlsGridBox.md)
* [5.18 NumericTextBx](/前端组件/NumericTextBox.md)
* [5.19 HlsNavigationBar](/前端组件/HlsNavigationBar.md)
* VI. 框架功能描述
* [6.1 计划任务](/框架功能描述/计划任务.md)
* [6.2 RabbitMq消息队列](/后端开发/RabbitMq消息队列.md)
* [6.3 应用服务部署(tomcat/weblogic)](/框架功能描述/deployment.md)
* [6.4 合同文本生成](/框架功能描述/docx4j.md)
* [6.5 Excel导入导出](/框架功能描述/jad.md)
* [6.6 redis安装和部署](/后端开发/redis.md)
# 融租易开发手册
* [GitBook使用](/gitbook.md)
---
* I. 开发环境准备
* [1.1 Git 使用](/git-guide.md "git指令")
* [1.2 Maven 使用](/maven.md "maven使用")
* [1.3 开发环境搭建](/project-create.md)
* [1.4 更新项目的HEL依赖版本](/project-update.md)
* [1.5 Liquibase](/liquibase-use.md)
* II. 项目开发规范
* [2.1 项目开发规范](/codeStyle.md#backEndDev)
* [2.2 编码规范](/codeStyle.md#backEndName)
* 2.3 Checkstyle
* III. 后端开发
* [3.1 后端开发说明\(1.0\)](/后端开发/dev-flow.md)
* [3.2 用户安全策略](/后端开发/user-security-strategy.md)
* [3.3 审计](/后端开发/audit.md)
* [3.4 锁机制](/后端开发/lock.md)
* [3.5 日志管理](/后端开发/elk.md)
* [3.6 代码生成器](/后端开发/code-generator.md)
* [3.7 跨域访问](/后端开发/3.24-cors.md)
* [3.8 消息机制](/后端开发/消息机制.md)
* IV. 前端JavaScript开发
* [4.1 前端开发说明 \(1.0\)](/front-kendoui.md)
* [4.2 字段级通用方法](/common-field-javascript.md)
* [4.3 窗口级通用方法](/common-window-javascript.md)
* [4.4 锁屏和解屏通用方法](/common-mask-javascript.md)
* V. 前端UI开发
* [5.1 hlsCombobox\(下拉框\)](/前端组件/hlsCombobox.md)
* [5.2 hlsDataSource\(数据源\)](/前端组件/hlsDataSource.md)
* [5.3 hlsMaskedTextBox\(文本框\)](/前端组件/hlsMaskedTextBox.md)
* [5.4 hlsPage\(分页控件\)](/前端组件/hlsPage.md)
* [5.5 hlsTextArea\(文本域\)](/前端组件/hlsTextArea.md)
* [5.6 hlsTlEdit\(多语言\)](/前端组件/hlsTlEdit.md)
* [5.7 hlsDatePicker\(日期选择框\)](/前端组件/hlsDatePicker.md)
* [5.8 hlsDateTimePicker\(时间选择框\)](/前端组件/hlsDateTimePicker.md)
* [5.9 hlsLov\(lov选择框\)](/前端组件/hlsLov.md)
* [5.10 hlsToolBar\(底部菜单栏\)](/前端组件/hlsToolBar.md)
* [5.11 TabStrip\(sheet页切换卡\)](/前端组件/tabStrip.md)
* [5.12 hlsForm\(表单\)](/前端组件/hlsForm.md)
* [5.13 hlsCombobox\(下拉框\)](/前端组件/hlsCombobox.md)
* [5.14 hlsCheckBox\(复选框\)](/前端组件/hlsCheckBox.md)
* [5.15 hlsGrid\(表格\)](/前端组件/hlsGrid.md)
* [5.16 dataSource\(数据源\)](/前端组件/dataSource.md)
* [5.17 hlsGridBox\(表格\)](/前端组件/hlsGridBox.md)
* [5.18 hlsNumericTextBox\(数字框\)](/前端组件/hlsNumericTextBox.md)
* [5.19 hlsNavigationBar\(导航栏\)](/前端组件/hlsNavigationBar.md)
* VI. 框架功能描述
* [6.1 计划任务](/框架功能描述/计划任务.md)
* [6.2 RabbitMq消息队列](/后端开发/RabbitMq消息队列.md)
* [6.3 应用服务部署\(tomcat/weblogic\)](/框架功能描述/deployment.md)
* [6.4 合同文本生成](/框架功能描述/docx4j.md)
* [6.5 Excel导入导出](/框架功能描述/jad.md)
* [6.6 redis安装和部署](/后端开发/redis.md)
* [6.7 工作流功能说明](/后端开发/activiti-helper.md)
* [6.8 工作流开发指南](/后端开发/activiti.md)
* [6.9 工作流demo](/后端开发/activiti_demo.md)
* [6.10 流程设计](/后端开发/activiti_editor_helper.md)
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment