# ApplicationStartupJob

**Repository Path**: allendong/ApplicationStartupJob

## Basic Information

- **Project Name**: ApplicationStartupJob
- **Description**: No description available
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2017-07-20
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

application-startup-job
====================================
###系统说明
本项目搭建了一个框架，在spring web项目启动前，执行一些工作。默认的实现是从jar包中拷贝文件到指定地点

###使用说明
>1、确保有maven环境

>2、下载本项目，使用命令行在根目录键入 ```mvn clean install```

>3、在spring web项目中引入依赖
```
<dependency>
    <groupId>com.seashell</groupId>
    <artifactId>application-startup-job</artifactId>
    <version>${version}</version>
</dependency>
```

>4、在自己项目中新建一个类继承```com.seashell.appstartupjob.listener.AbstractApplicationStartupListener```

>5、在`web.xml`中添加`<listener>`节点，class设置为刚刚创建的listener

>6、新增一个配置文件，默认文件为根目录下```application-start-up.xml```文件。配置文件可在第四步新建的类中，通过实现方法```getConfigFilePath()```替换。

###配置文件框架编写说明
job的内容根据不同Job类而定

>1、框架
```
<?xml version="1.0" encoding="UTF-8"?>
<config  xmlns="http://seashell.com/startUpJobSchema.xsd">
    <jobs>
        <job>
            ...
        </job>
    </jobs>
</config>
```

###jarFileTransJob节点说明
jarFileTransJob是本项目的默认Job实现，其功能是从Jar拷贝指定内容到目的文件夹中

####\<name\>
>是否必须：否<br/>
说明：工作名称

####\<class\>
>是否必须：是<br/>
说明：具体Job执行类的全路径

####\<worker-class\>
>是否必须：否<br/>
说明：具体Job执行类管理的工人类的全路径，同一种Job可由不同技能的工人来完成实施。如不填写，系统使用默认实现类`JarFileTransWorker`

####\<expression\>
>是否必须：是<br/>
说明：系统匹配符合移动任务的表达式。表达式可采取模糊匹配。<br/>
如：<br/>
/webapp/**              匹配/webapp/ 目录下的所有文件以及文件夹<br/>
/webapp/*               匹配/webapp/ 目录下的所有文件，不包含文件夹<br/>
/webapp/test*           匹配/webapp/ 目录下以test开头的文件<br/>
/webapp/\*test          匹配/webapp/ 目录下以test结尾的文件<br/>
/webapp/test*/test1/**  匹配/webapp/目录下test开头的目录下的test1目录下的所有文件以及文件夹<br/>

####\<resource-path-cut\>
>是否必须：否<br/>
说明：拷贝到对应目录后，原路径前面要剪掉的部分。

####\<des-path\>
>是否必须：是<br/>
说明：拷贝目标地址。

####\<des-path-type\>
>是否必须：是<br/>
说明：拷贝目标地址类型。类型可设置为`web`和`absolute`分别代表web相对地址和系统绝对地址。

####\<copy-type\>
>是否必须：是<br/>
说明：拷贝策略。策略可设置为`override`和`ignore`。前者代表复制过去覆盖原有文件，后者代表，如果目标地址不存在该文件，才执行复制。

####\<includes\>
>是否必须：是<br/>
说明：在`<expression>`的匹配范围内，进一步缩小匹配范围。表达式规则同`<expression>`。

####\<excludes\>
>是否必须：是<br/>
说明：在`<expression>`的匹配范围内，排除部分文件。表达式规则同`<expression>`。