［niubi-job——一個分布式的任務調度框架］----如何開發一個niubi-job的定時任務

<artifactId>niubi-job-example-spring</artifactId>

<dependencies>
    <!-- 為了本地測試,依舊要引入該包 -->
    <dependency>
        <groupId>com.zuoxiaolong</groupId>
        <artifactId>niubi-job-scheduler</artifactId>
        <version>0.9.2</version>
    </dependency>
    <!-- spring環境與非spring環境的任務最不同的就是spring環境的任務需要多引入這個包 -->
    <!-- 并且該包需要一起打到jar包當中 -->
    <dependency>
        <groupId>com.zuoxiaolong</groupId>
        <artifactId>niubi-job-spring</artifactId>
        <version>0.9.2</version>
    </dependency>
    <!-- 這是spring的jar包 -->
    <dependency>
        <groupId>org.springframework</groupId>
        <artifactId>spring-context</artifactId>
        <version>4.2.4.RELEASE</version>
    </dependency>
</dependencies>

<profiles>
    <profile>
        <!-- 以下配置與非spring環境一模一樣 -->
        <id>release</id>
        <dependencyManagement>
            <dependencies>
                <dependency>
                    <groupId>com.zuoxiaolong</groupId>
                    <artifactId>niubi-job-scheduler</artifactId>
                    <version>0.9.2</version>
                    <scope>provided</scope>
                </dependency>
            </dependencies>
        </dependencyManagement>
        <build>
            <finalName>niubi-job-example-spring</finalName>
            <plugins>
                <plugin>
                    <groupId>org.apache.maven.plugins</groupId>
                    <artifactId>maven-shade-plugin</artifactId>
                    <version>2.4.2</version>
                    <executions>
                        <execution>
                            <phase>package</phase>
                            <goals>
                                <goal>shade</goal>
                            </goals>
                            <configuration>
                                <transformers>
                                    <transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
                                        <resource>META-INF/spring.handlers</resource>
                                    </transformer>
                                    <transformer implementation="org.apache.maven.plugins.shade.resource.AppendingTransformer">
                                        <resource>META-INF/spring.schemas</resource>
                                    </transformer>
                                </transformers>
                            </configuration>
                        </execution>
                    </executions>
                </plugin>
            </plugins>
        </build>
    </profile>

</profiles>

</project></pre>

可以看到，與上面非spring環境相比，最大的不同就是多引入了一個niubi-job-spring的依賴，并且該包需要一起打到你的jar包當中，因此在release的profile中，把niubi-job-scheduler的scope改成了provided，但是niubi-job-spring卻沒任何改變。

還需要特別的一點是，niubi-job會自動掃描classpath下是否存在applicationContext.xml文件，以此來判斷是否要以spring環境運行該jar包。因此，如果你希望你的jar包運行在spring環境中，請務必在你的classpath下建立一個applicationContext.xml文件。

如果你原本的spring配置文件不叫applicationContext.xml，而你又不想改原本spring配置的名字，那么可以在classpath建立一個applicationContext.xml文件，并且將你原本的spring配置文件用import標簽導入。

總結

接下來，總結一下niubi-job對上傳的任務jar包的要求。

1、jar包必須包含自己本身的依賴，例如數據庫驅動等。（使用maven的shade插件就可以將依賴一起打包，如果是其它構建工具，請自行查找方法，應該不難）

2、jar包中不能包含niubi-job-scheduler以及其依賴的jar包，也就是不能包含niubi-job-cluster解壓后lib內的jar包。（比如log4j， gson等，具體的可以自行查看）

3、如果需要spring的運行環境，請額外引入niubi-job-spring，并且在classpath下建立一個包含了你的spring配置的applicationContext.xml文件。（如果你的spring配置文件原本就叫applicationContext.xml，那就不需要專門建立applicationContext.xml文件了）

4、如果需要在本地測試，則在開發時將niubi-job-scheduler這個jar的scope設成compile，并且給你任務方法上的Schedule注解加上cron屬性。記得，在打成jar包時將niubi-job-scheduler的scope改成provided。

任務jar包中的日志

當你引入niubi-job-scheduler這個jar包的時候，你可以找到一個LoggerHelper的類，它里面包含了一些打印日志的方法。強烈建議，如果要在任務中打印日志的話，請使用該類。使用該類打印的日志，都將出現在niubi-job-cluster的logs文件夾的日志文件里，可以非常方便的查看，也便于后期與elasticsearch集成。

有關和elasticsearch集成的內容，后期LZ會補充上來。集成以后，你可以非常方便的查看任務運行日志。如果你的公司本身就有一套基于elasticsearch的日志查看系統，那就更加完美了。

結束語

niubi-job是LZ傾心打造的一個項目，LZ會出一系列文章來介紹它，包括如何使用以及它的一些設計思想和原理，有興趣的同學可以關注一下。

如果你的項目剛好缺一個定時任務的調度框架，那么niubi-job應該是你不二的選擇！

當然，如果你有興趣參與進來，也可以在Github上面給LZ提交PR，LZ一定盡職盡責的進行review。