检查字符串是否为合法的日期格式从以下三个方面说起:
1、字符串格式是否正确,比如格式是否是yyyy-MM-dd
2、时间是否在合法范围内,比如我们需要限定在一个月内的时间
3、字符串是否可以解析为正常的时间,比如2月30号就不是正常的时间
第一种:使用DateFormat检查
1、定义时间校验器的接口
接口方法接收一个字符串,返回布尔类型,标识字符串是否是合法的时间格式
public interface DateValidator {
boolean isValid(String dateStr);
}
2、使用DateFormat检查
Java提供了格式化和解析时间的工具:DateFormat抽象类和SimpleDateFormat实现类,借此实现时间校验器。
import com.example.smile.result.configuration.DateValidator;
import java.text.DateFormat;
import java.text.SimpleDateFormat;
public class DateValidatorUsingDateFormat implements DateValidator {
private final String dateFormat;
public DateValidatorUsingDateFormat(String dateFormat) {
this.dateFormat = dateFormat;
}
@Override
public boolean isValid(String dateStr) {
final DateFormat sdf = new SimpleDateFormat(this.dateFormat);
sdf.setLenient(false);
try {
sdf.parse(dateStr);
}catch (Exception e){
System.out.println("false");
return false;
}
System.out.println("true");
return true;
}
}
3、使用示例
需要注意的是DateFormat和SimpleDateFormat是非线程安全的,所以每次方法调用时,都需要新建实例。
import com.example.smile.result.configuration.DateValidator;
import com.example.smile.result.utils.DateValidatorUsingDateFormat;
import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;
@SpringBootTest
@Slf4j
public class DateValidatorUsingDateFormatTest {
@Test
void isValid(){
final DateValidator validator = new DateValidatorUsingDateFormat("yyyy-MM-dd");
Assertions.assertTrue(validator.isValid("2021-02-28"));
Assertions.assertTrue(validator.isValid("2021-02-30"));
}
}
第二种:使用LocalDate检查
JDK8引入了更加好用的日期和时间API。其中包括LocalDate类,是一个不可变且线程安全的时间类。
1、定义时间校验器的接口
public interface DateValidator {
boolean isValid(String dateStr);
}
2、通过LocalDate的parse方法实现我们的校验器
import com.example.smile.result.configuration.DateValidator;
import java.time.LocalDate;
import java.time.format.DateTimeFormatter;
import java.time.format.DateTimeParseException;
public class DateValidatorUsingDateFormat implements DateValidator {
private final DateTimeFormatter dateTimeFormatter;
public DateValidatorUsingDateFormat(DateTimeFormatter dateTimeFormatter){
this.dateTimeFormatter = dateTimeFormatter;
}
@Override
public boolean isValid(String dateStr) {
try {
LocalDate.parse(dateStr,this.dateTimeFormatter);
}catch (DateTimeParseException e){
return false;
}
return true;
}
}
3、使用示例
java.time.format.DateTimeFormatter类是不可变的,也就是天然的线程安全,我们可以在不同线程使用同一个校验器实例。
import com.example.smile.result.configuration.DateValidator;
import com.example.smile.result.utils.DateValidatorUsingDateFormat;
import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;
import java.time.format.DateTimeFormatter;
@SpringBootTest
@Slf4j
public class DateValidatorUsingDateFormatTest {
@Test
void isValid(){
final DateTimeFormatter dateTimeFormatter = DateTimeFormatter.ISO_LOCAL_DATE;
final DateValidator validator = new DateValidatorUsingDateFormat(dateTimeFormatter);
Assertions.assertTrue(validator.isValid("2021-02-28"));
Assertions.assertTrue(validator.isValid("2021-02-30"));
}
}
第三种:使用DateTimeFormatter检查
DateTimeFormatter解析文本总共分两步。第一步,根据配置将文本解析为日期和时间字段;第二步,用解析后的字段创建日期和时间对象
1、定义时间校验器的接口
public interface DateValidator {
boolean isValid(String dateStr);
}
2、实现验证器
import com.example.smile.result.configuration.DateValidator;
import java.time.LocalDate;
import java.time.format.DateTimeFormatter;
import java.time.format.DateTimeParseException;
public class DateValidatorUsingDateFormat implements DateValidator {
private final DateTimeFormatter dateTimeFormatter;
public DateValidatorUsingDateFormat(DateTimeFormatter dateTimeFormatter){
this.dateTimeFormatter = dateTimeFormatter;
}
@Override
public boolean isValid(String dateStr) {
try {
LocalDate.parse(dateStr,this.dateTimeFormatter);
}catch (DateTimeParseException e){
return false;
}
return true;
}
}
3、使用示例
import com.example.smile.result.configuration.DateValidator;
import com.example.smile.result.utils.DateValidatorUsingDateFormat;
import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;
import java.time.format.DateTimeFormatter;
import java.time.format.ResolverStyle;
import java.util.Locale;
@SpringBootTest
@Slf4j
public class DateValidatorUsingDateFormatTest {
private static final DateTimeFormatter DATE_FORMATTER = DateTimeFormatter.ofPattern("uuuu-MM-dd", Locale.CHINA);
@Test
void isValid(){
final DateTimeFormatter dateTimeFormatter = DATE_FORMATTER.withResolverStyle(ResolverStyle.STRICT);
final DateValidator validator = new DateValidatorUsingDateFormat(dateTimeFormatter);
Assertions.assertTrue(validator.isValid("2021-02-28"));
Assertions.assertTrue(validator.isValid("2021-02-30"));
}
}
可以看到,我们指定了转换模式是ResolverStyle.STRICT,这个类型是说明解析模型。共有三种:
1、STRICT:严格模式,日期、时间必须完全正确
2、SMART:智能模式,针对日可以自动调整。月的范围在 1 到 12,日的范围在 1 到 31。比如输入是 2 月 30 号,当年 2 月只有 28 天,返回的日期就是 2 月 28 日
3、LENIENT:宽松模式,主要针对月和日,会自动后延。结果类似于LocalData#plusDays
或者LocalDate#plusMonths
示例如下:
import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;
import java.time.LocalDate;
import java.time.format.DateTimeFormatter;
import java.time.format.DateTimeParseException;
import java.time.format.ResolverStyle;
import java.util.Locale;
@SpringBootTest
@Slf4j
public class DateValidatorUsingDateFormatTest {
private static final DateTimeFormatter DATE_FORMATTER = DateTimeFormatter.ofPattern("uuuu-MM-dd", Locale.CHINA);
private static LocalDate parseDate(String dateString, ResolverStyle resolverStyle) {
try {
return LocalDate.parse(dateString, DATE_FORMATTER.withResolverStyle(resolverStyle));
} catch (DateTimeParseException e) {
return null;
}
}
@Test
void testResolverStyle() {
Assertions.assertEquals(LocalDate.of(2021, 2, 28), parseDate("2021-02-28", ResolverStyle.STRICT));
Assertions.assertNull(parseDate("2021-02-29", ResolverStyle.STRICT));
Assertions.assertEquals(LocalDate.of(2021, 2, 28), parseDate("2021-02-28", ResolverStyle.STRICT));
Assertions.assertNull(parseDate("2021-13-28", ResolverStyle.STRICT));
Assertions.assertEquals(LocalDate.of(2021, 2, 28), parseDate("2021-02-28", ResolverStyle.SMART));
Assertions.assertEquals(LocalDate.of(2021, 2, 28), parseDate("2021-02-29", ResolverStyle.SMART));
Assertions.assertNull(parseDate("2021-13-28", ResolverStyle.SMART));
Assertions.assertNull(parseDate("2021-13-29", ResolverStyle.SMART));
Assertions.assertEquals(LocalDate.of(2021, 2, 28), parseDate("2021-02-28", ResolverStyle.LENIENT));
Assertions.assertEquals(LocalDate.of(2021, 3, 1), parseDate("2021-02-29", ResolverStyle.LENIENT));
Assertions.assertEquals(LocalDate.of(2022, 1, 28), parseDate("2021-13-28", ResolverStyle.LENIENT));
Assertions.assertEquals(LocalDate.of(2022, 2, 2), parseDate("2021-13-33", ResolverStyle.LENIENT));
}
}
从例子可以看出,ResolverStyle.STRICT
是严格控制,用来做时间校验比较合适;ResolverStyle.LENIENT
可以最大程度将字符串转化为时间对象,在合理范围内可以随便玩;ResolverStyle.SMART
名为智能,但智力有限,两不沾边,优势不够明显。JDK 提供的DateTimeFormatter
实现,都是ResolverStyle.STRICT
模式
第四种:Apache出品的commons-validator检查
Apache Commons项目提供了一个校验器框架,包含多种校验规则,包括日期、时间、数字、货币、IP地址、邮箱、URL地址等。
本文主要说检查时间,所以重点看GenericValidator
类提供的isDate
方法
1、添加依赖
<dependency>
<groupId>commons-validator</groupId>
<artifactId>commons-validator</artifactId>
<version>1.7</version>
</dependency>
2、定义时间校验器的接口
public interface DateValidator {
boolean isValid(String dateStr);
}
3、实现验证器
import com.example.smile.result.configuration.DateValidator;
import org.apache.commons.validator.GenericValidator;
public class DateValidatorUsingDateFormat implements DateValidator {
private final String dateFormat;
public DateValidatorUsingDateFormat(String dateFormat){
this.dateFormat = dateFormat;
}
@Override
public boolean isValid(String dateStr) {
return GenericValidator.isDate(dateStr,dateStr,true);
}
}
4、使用示例
import com.example.smile.result.configuration.DateValidator;
import com.example.smile.result.utils.DateValidatorUsingDateFormat;
import lombok.extern.slf4j.Slf4j;
import org.junit.jupiter.api.Assertions;
import org.junit.jupiter.api.Test;
import org.springframework.boot.test.context.SpringBootTest;
@SpringBootTest
@Slf4j
public class DateValidatorUsingDateFormatTest {
@Test
void isValid(){
final DateValidator dateValidator = new DateValidatorUsingDateFormat("yyyy-MM-dd");
Assertions.assertTrue(dateValidator.isValid("2021-02-28"));
Assertions.assertTrue(dateValidator.isValid("2021-02-30"));
}
}
在本文中,我们通过四种方式实现了时间字符串校验逻辑。其中DateFormat
和SimpleDataFormat
是非线程安全的,所以每次方法调用时,都需要新建实例;apache.commons.validator.DateValidator#isValid
它的内部也是通过DateFormat
和SimpleDateFormat
实现的;而LocalDate和DateTimeFormatter则为JDK8中提供的实现方法。