ddpush 学习之路 2 DateTimeUtil.java

解释的第一个类。是org.ddpush.im.util包中的 DateTimeUtil.java

来。先上我注释的该类代码，在类注释下面，会有具体的使用代码以及结果

public class DateTimeUtil {

/**
* DateTimeUtil 类中的一个静态常量
* 是用来格式化日期时间的格式
* yyyy-MM-dd HH:mm:ss
* */
public static String DEFAULTFORMAT = "yyyy-MM-dd HH:mm:ss";

/**
* DateTimeUtil 类中的 getCurDateTime 静态函数
* 作用：根据默认的 DEFAULTFORMAT 格式 返回当前日期时间
* 参考结果：2015-03-15 13:35:42
* */
public static String getCurDateTime() {
return getCurDateTime(DEFAULTFORMAT);
}

/**
* DateTimeUtil 类中的 getCurDateTime(String pattern) 静态函数
* 作用： 根据传入的日期时间格式 返回当前的日期时间
* 参考结果:13:35:42
* */
public static String getCurDateTime(String pattern) {
return formatCalendar(Calendar.getInstance(),pattern);
}

/**
* DateTimeUtil 类中的 formatCalendar(Calendar calendar) 静态函数
* 作用：根据传入的 Calendar 对象 返回 DEFAULTFORMAT 格式的日期时间字符串
* 参考结果:2015-03-15 13:35:42
* */
public static String formatCalendar(Calendar calendar){
return formatCalendar(calendar,DEFAULTFORMAT);
}

/**
* DateTimeUtil 类中的 formatCalendar(Calendar calendar, String pattern) 静态函数
* 作用：根据传入的 Calendar 对象 和 传入的 日期格式化pattern 返回 一个日期时间字符串
* 参考结果:2015-03-15 13:35:42
* */
public static String formatCalendar(Calendar calendar,String pattern){
SimpleDateFormat sdf = new SimpleDateFormat(pattern);
//sdf.setTimeZone(TimeZone.getTimeZone(timeZone));
return sdf.format(calendar.getTime());
}

/**
* DateTimeUtil 类中的 parseDate(String date) 静态函数
* 作用：根据传入的字符串形式的时间日期转换成Date 对象
* 参考结果:2015-03-15 00:00:00
* */
public static Date parseDate(String date) throws ParseException{
／／调用StringUtil 这个工具类来检测传入的字符串 date 是否为 null
if("".equals(StringUtil.checkBlankString(date)))
return null;
SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd");
return  sdf.parse(date);
}

/**
* DateTimeUtil 类中的 parseDate(String date, String pattern) 静态函数
* 作用：根据传入的日期时间字符串 和 该日期时间的格式化pattern 返回 Date对象
* 参考结果:1426426542000
* */
public static Date parseDate(String date, String pattern) throws ParseException{
／／调用StringUtil 这个工具类来检测传入的字符串 date 是否为 null
if("".equals(StringUtil.checkBlankString(date)))
return null;
SimpleDateFormat sdf = new SimpleDateFormat(pattern);
return  sdf.parse(date);
}

/**
* DateTimeUtil 类中的 formatDate(Date date, String pattern) 静态函数
* 作用：将传入的 Date对象根据传入的 pattern 格式化成字符串 并返回
* 参考结果:2015-03-15 13:35:42
* */
public static String formatDate(Date date, String pattern){
if(date==null)
return "";
Calendar calendar = Calendar.getInstance();
calendar.setTime(date);
return formatCalendar(calendar,pattern);
}

/**
* DateTimeUtil 类中的 formatDate(Date date) 静态函数
* 作用：将传入的 Date对象根据默认的 DEFAULTFORMAT 日期时间格式 格式化成字符串并返回
* 参考结果:2015-03-15 00:00:00
* */
public static String formatDate(Date date){
return formatDate(date,DEFAULTFORMAT);
}

/**
* DateTimeUtil 类中的 parseString(String dateStr, String pattern) 静态函数
* 作用：将传入的String类型的日期时间字符串 dateStr 根据传入的 pattern 格式
*      转换成Calendar对象并返回
* 参考结果:2015-03-15 14:18:29
* */
public static Calendar parseString(String dateStr, String pattern) throws ParseException{
SimpleDateFormat sdf = new SimpleDateFormat(pattern);
Date date = sdf.parse(dateStr);
Calendar calendar = Calendar.getInstance();
calendar.setTime(date);
return calendar;
}

/**
* DateTimeUtil 类中的 convertDateTimeStrFormat
* (String dateStr, String pattern, String newPattern) 静态函数
*
* 作用：将传入的String类型的日期时间字符串 dateStr 根据 dateStr 的pattern
*      用新的 newPattern格式化成String类型的时间日期字符串 并返回
* 参考结果:14:24:04
* */
public static String convertDateTimeStrFormat(String dateStr, String pattern, String newPattern) throws ParseException{
return DateTimeUtil.formatCalendar(DateTimeUtil.parseString(dateStr,pattern),newPattern);
}

/**
* DateTimeUtil 类中的 parseString(String dateStr) 静态函数
* 作用：将传入的String 类型的时间日期字符串 dateStr 使用DEFAULTFORMAT pattern
*      转换成 Calendar 对象 并返回
* 参考结果:2015-03-15 14:31:33
* */
public static Calendar parseString(String dateStr)throws ParseException{
return parseString(dateStr,DEFAULTFORMAT);
}
}

好了，以上就是 DateTimeUtil.java 这个工具类的翻译注释了。

这个类主要是处理各种时间日期的格式化问题，以及获取指定格式的时间日期，同时 提供各种状态下的时间日期之间的转换。说白了就是 时间日期操作 转换 就找这个类就可以了。

下面我们来实际的使用这个类用实际的执行结果来帮助我们去了解作用

/**
* DateTimeUtil 类中的一个静态常量 DEFAULTFORMAT
* 是用来格式化日期时间的格式
* 结果：yyyy-MM-dd HH:mm:ss
* */
System.out.println(DateTimeUtil.DEFAULTFORMAT);

/**
* DateTimeUtil 类中的 getCurDateTime 静态函数
* 作用：根据默认的 DEFAULTFORMAT 格式 返回当前日期时间
* 结果：getCurDateTime:2015-03-15 13:35:42
* */
String getCurDateTime = getCurDateTime();
System.out.println("getCurDateTime:" + getCurDateTime );

/**
* DateTimeUtil 类中的 getCurDateTime(String pattern) 静态函数
* 作用： 根据传入的日期时间格式 返回当前的日期时间
* 结果：getCurDateTimePattern:13:35:42
* */
String getCurDateTimePattern = getCurDateTime("HH:mm:ss");
System.out.println("getCurDateTimePattern:" + getCurDateTimePattern);

/**
* DateTimeUtil 类中的 formatCalendar(Calendar calendar) 静态函数
* 作用：根据传入的 Calendar 对象 返回 DEFAULTFORMAT 格式的日期时间字符串
* 结果：formatCalendarCalendar:2015-03-15 13:35:42
* */
String formatCalendarCalendar = formatCalendar(Calendar.getInstance());
System.out.println("formatCalendarCalendar:" + formatCalendarCalendar);

/**
* DateTimeUtil 类中的 formatCalendar(Calendar calendar, String pattern) 静态函数
* 作用：根据传入的 Calendar 对象 和 传入的 日期格式化pattern 返回 一个日期时间
* 结果：formatCalendarCalendarPattern:2015-03-15 13:35:42
* */
String formatCalendarCalendarPattern = formatCalendar(Calendar.getInstance(), "yyyy-MM-dd HH:mm:ss");
System.out.println("formatCalendarCalendarPattern:" + formatCalendarCalendarPattern);

/**
* DateTimeUtil 类中的 parseDate(String date) 静态函数
* 作用：根据传入的字符串形式的时间日期转换成Date 对象
* 结果：parseDateStringDate:2015-03-15 00:00:00
* */
try {
Date parseDateStringDate = parseDate(getCurDateTime("yyyy-MM-dd"));
System.out.println("parseDateStringDate:" + new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(parseDateStringDate));
} catch (ParseException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}

/**
* DateTimeUtil 类中的 parseDate(String date, String pattern) 静态函数
* 作用：根据传入的日期时间字符串 和 该日期时间的格式化pattern 返回 Date对象
* 结果：parseDateStringDateStringPattern:1426426542000
* */
try {
Date parseDateStringDateStringPattern = parseDate(getCurDateTime(), "yyyy-MM-dd HH:mm:ss");
System.out.println("parseDateStringDateStringPattern:" + parseDateStringDateStringPattern.getTime());
} catch (ParseException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}

/**
* DateTimeUtil 类中的 formatDate(Date date, String pattern) 静态函数
* 作用：将传入的 Date对象根据传入的 pattern 格式化成字符串
* 结果：formatDateDatedateStringPattern:2015-03-15 13:35:42
* */
try {
String formatDateDatedateStringPattern = formatDate(parseDate(getCurDateTime(), "yyyy-MM-dd HH:mm:ss"));
System.out.println("formatDateDatedateStringPattern:" + formatDateDatedateStringPattern);
} catch (ParseException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}

/**
* DateTimeUtil 类中的 formatDate(Date date) 静态函数
* 作用：将传入的 Date对象根据默认的 DEFAULTFORMAT 日期时间格式 格式化成字符串并返回
* 结果：formatDateDatedate:2015-03-15 00:00:00
* */
try {
String formatDateDatedate = formatDate(parseDate(getCurDateTime()));
System.out.println("formatDateDatedate:" + formatDateDatedate);
} catch (ParseException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}

/**
* DateTimeUtil 类中的 parseString(String dateStr, String pattern) 静态函数
* 作用：将传入的String类型的日期时间字符串 dateStr 根据传入的 pattern 格式 转换成Calendar对象并返回
* 结果：parseStringStringdateStrStringpattern:2015-03-15 14:18:29
* */
try {
Calendar parseStringStringdateStrStringpattern = parseString(getCurDateTime(), DEFAULTFORMAT);
System.out.println("parseStringStringdateStrStringpattern:" + formatCalendar(parseStringStringdateStrStringpattern) );
} catch (ParseException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}

/**
* DateTimeUtil 类中的 convertDateTimeStrFormat(String dateStr, String pattern, String newPattern) 静态函数
* 作用：将传入的String类型的日期时间字符串 dateStr 根据 dateStr 的pattern 用新的 newPattern格式化成String类型的时间日期字符串 并返回
* 结果：convertDateTimeToNewPattern:14:24:04
* */
try {
String convertDateTimeToNewPattern = convertDateTimeStrFormat(getCurDateTime(), DEFAULTFORMAT, "HH:mm:ss");
System.out.println("convertDateTimeToNewPattern:" + convertDateTimeToNewPattern);
} catch (ParseException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}

/**
* DateTimeUtil 类中的 parseString(String dateStr) 静态函数
* 作用：将传入的String 类型的时间日期字符串 dateStr 使用DEFAULTFORMAT pattern 转换成 Calendar 对象 并返回
* 结果：parseStringStringdateStr:2015-03-15 14:31:33
* */
try {
Calendar parseStringStringdateStr = parseString(getCurDateTime());
System.out.println("parseStringStringdateStr:" + formatCalendar(parseStringStringdateStr));
} catch (ParseException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}

执行结果

DEFAULTFORMAT:yyyy-MM-dd HH:mm:ss
getCurDateTime:2015-03-15 16:30:41
getCurDateTimePattern:16:30:41
formatCalendarCalendar:2015-03-15 16:30:41
formatCalendarCalendarPattern:2015-03-15 16:30:41
parseDateStringDate:2015-03-15 00:00:00
parseDateStringDateStringPattern:1426437041000
formatDateDatedateStringPattern:2015-03-15 16:30:41
formatDateDatedate:2015-03-15 00:00:00
parseStringStringdateStrStringpattern:2015-03-15 16:30:41
convertDateTimeToNewPattern:16:30:41
parseStringStringdateStr:2015-03-15 16:30:41

好了。以上就是 DateTimeUtil.java 的翻译注释。整体的翻译注释完毕之后。我们明白了。这个类就是一个做时间日期操作转换的工具类。并提供了一个 DEFAULTFORMAT 的 时间日期格式化pattern的常量，同时申明一下。我不认为我这一段结论是多此一举，有人认为这很简单，但是也同时有人认为这不怎么简单。我今后也要努力做一个能 尊重 程序员 的人。

by brok1n 20150315