Spring Boot获取节假日API

项目场景：

需要知道某一天是不是节假日，或者是休息日。

---

问题描述

我们知道每年的假节日要等国家规定好，我们才能知道，所以自己是算不出的。

马上想到的两个解决方法：

1.通过调用互联网的节假日API（优点：方便，缺点：主动权在别人手里，万一别人的服务器出了问题，自己的服务也会受影响）

2.每年自己手动配置一次（优点：安全不会出问题，缺点：麻烦）

感觉都不是很完美，最后把这两种结合一下，生成的解决方案：

每年年底定时去调用互联网的节假日API，做个异常捕捉，如果同步失败，证明这个接口可能出了问题，然后再去手动配置。后面再去排查接口的问题，如果是接口已经停用了，那么再换另一个节假日API的接口，重新调整。所以最好选个比较稳定的第三方接口。

我这边用的是RollToolsApi官网：https://www.mxnzp.com/

---

解决方案：

节假日接口：https://www.mxnzp.com/doc/detail?id=1

关键代码：我这里只是打印了日期，没有入库，大家可以入库保存，其中app_id和app_secret需要在官网创建，是免费的。

package com.test.controller;
 
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.util.CollectionUtils;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.client.RestTemplate;
 
import com.test.dto.Holiday;
import com.test.dto.HolidayData;
import com.test.dto.HolidayResult;
 
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
 
@RestController
@RequestMapping("/day")
@Api(value = "节假日")
public class TestController {
	
	@Autowired
	private RestTemplate restTemplate;
	
	@RequestMapping(value = "getDay", method = RequestMethod.GET)
	@ApiOperation(value = "测试")
	public String getDay() {
		/*
		 * 互联网节假日api接口，公安网需要主动导入配置
		 * www.mxnzp.com
		 * ignoreHoliday: 是否忽略节假日，仅仅获取万年历，默认值false
		 */
		String url = "https://www.mxnzp.com/api/holiday/list/year/2022"
				+ "?ignoreHoliday=false&app_id=登录官网创建&app_secret=登录官网创建";
		HolidayResult result = restTemplate.getForObject(url, HolidayResult.class);
		
		if(result.getCode() != null && result.getCode() == 1){
			//成功: code: 状态码 1.返回成功 0.返回失败
			if(!CollectionUtils.isEmpty(result.getData())){
				for (HolidayData data : result.getData()) {
					System.out.println("月份: "+data.getMonth());
					for (Holiday day : data.getDays()) {
						System.out.println(day.getDate()+"\t"+day.getType()+"\t"+day.getTypeDes());
					}
					System.out.println("\n");
				}
			}
		}else{
			//失败
		}
		
		return result.getMsg();
	}
	
	@RequestMapping(value = "importDay", method = RequestMethod.POST)
	@ApiOperation(value = "测试导入")
	public String importDay(@RequestBody HolidayResult result) {
		if(result == null){
			return "不能为空";
		}
		
		if(result.getCode() != null && result.getCode() == 1){
			//成功: code: 状态码 1.返回成功 0.返回失败
			if(!CollectionUtils.isEmpty(result.getData())){
				for (HolidayData data : result.getData()) {
					System.out.println("月份: "+data.getMonth());
					for (Holiday day : data.getDays()) {
						System.out.println(day.getDate()+"\t"+day.getType()+"\t"+day.getTypeDes());
					}
					System.out.println("\n");
				}
			}
		}else{
			//失败
		}
		
		return result.getMsg();
	}
	
}

实体类用于接收响应结果

HolidayResult

package com.test.dto;
 
import java.util.List;
 
import lombok.Data;
 
@Data
public class HolidayResult {
 
	private Integer code;	//状态码 1.返回成功 0.返回失败
	private String msg;	//提示信息
	private List data;
}

HolidayData

package com.test.dto;
 
import java.util.List;
 
import lombok.Data;
 
@Data
public class HolidayData {
 
	private Integer month;	//当前月份
	private Integer year;	//当前年份
	private List days;
}

Holiday

package com.test.dto;
 
import lombok.Data;
 
@Data
public class Holiday {
 
	private String date;	//当前日期
	private Integer weekDay;	//当前周第几天 1-周一 2-周二 ... 7-周日
	private String yearTips;	//天干地支纪年法描述 例如：戊戌
	private Integer type;	//类型 0 工作日 1 休息日 2 节假日 如果ignoreHoliday参数为true，这个字段不返回
	private String typeDes;	//类型描述 比如 国庆,休息日,工作日 如果ignoreHoliday参数为true，这个字段不返回
	private String chineseZodiac;	//属相 例如：狗
	private String solarTerms;	//节气描述 例如：小雪
	private String avoid;	//不宜事项
	private String lunarCalendar;	//农历日期
	private String suit;	//宜事项
	private Integer dayOfYear;	//这一年的第几天
	private Integer weekOfYear;	//这一年的第几周
	private String constellation;	//星座
	private Integer indexWorkDayOfMonth;	//如果当前是工作日 则返回是当前月的第几个工作日，否则返回0 如果ignoreHoliday参数为true，这个字段不返回
}

我这里手动配置是采用json参数的方式，大家可以改为导入文件的方式。

源码：https://download.csdn.net/download/u011974797/86513910