编写简单的使用说明
This commit is contained in:
parent
bedeb353e1
commit
ae8ea85cbe
34
README.md
34
README.md
|
|
@ -1,3 +1,35 @@
|
|||
# youfool-holiday-sdk
|
||||
|
||||
youfool-holiday调度sdk
|
||||
youfool-holiday调度sdk
|
||||
|
||||
## 使用方法
|
||||
|
||||
### 配置初始化
|
||||
|
||||
```java
|
||||
// 初始化假期计算器
|
||||
HolidayCalculatorConfig config = new HolidayCalculatorConfig();
|
||||
// 是否在线同步数据模式
|
||||
config.setOnline(Boolean.parseBoolean(environment.getProperty("holiday.online")));
|
||||
// 离线模式配置文件路径(默认:classpath:holiday)
|
||||
config.setConfigPath(environment.getProperty("holiday.config-path"));
|
||||
// 工作时间区间配置,多个用;隔开,示例:08:00-12:00;14:00-17:00
|
||||
config.setWorkTime(environment.getProperty("holiday.work-time"));
|
||||
// 数据同步间隔,默认-1(只在初始化时同步)
|
||||
String interval = environment.getProperty("holiday.flush-interval");
|
||||
if (interval != null) {
|
||||
config.setFlushInterval(Long.parseLong(interval.trim()));
|
||||
}
|
||||
HolidayCalculator.init(config);
|
||||
```
|
||||
|
||||
### 初始化后调用
|
||||
|
||||
```java
|
||||
// 推算工作日
|
||||
HolidayCalculator.calcWorkDate(LocalDate.now(), 4);
|
||||
// 判断是否是工作日
|
||||
HolidayCalculator.isWorkDay(LocalDate.now());
|
||||
// 判断限制是否为工作时间
|
||||
HolidayCalculator.isWorkTime(LocalDateTime.now());
|
||||
```
|
||||
Loading…
Reference in New Issue