在Java 8下更好地利用枚举
程序员文章站
2022-04-15 21:13:40
...
在我们的云使用分析API中,返回了格式化过的分析数据(这里指生成分析图)。最近,我们添加了一个特性,允许用户选择时间段(最开始只可以按天选择)。问题是,代码中每天中的时间段部分高度耦合了……
例如,下面这段代码:
private static List<DataPoint> createListWithZerosForTimeInterval(DateTime from, DateTime to, ImmutableSet<Metric<? extends Number>> metrics) { List<DataPoint> points = new ArrayList<>(); for (int i = 0; i <= Days.daysBetween(from, to).getDays(); i++) { points.add(new DataPoint().withDatas(createDatasWithZeroValues(metrics)) .withDayOfYear(from.withZone(DateTimeZone.UTC) .plusDays(i) .withTimeAtStartOfDay())); } return points; }
注意:Days、Minutes、Hours、Weeks 和Months一样出现在代码的后面部分。这些代码来自Joda-Time Java时间和日期API。甚至方法的名字都没有反应出(各自的功能)。这些名字牢牢的绑定到了days的概念上。
我也尝试过使用不同时间段方式(比如月、周、小时)。但我看到了糟糕的switch/case鬼鬼祟祟地隐藏在代码里。
你需要知道,switch/case=罪恶 已经深入我心了。在我大学期间的两段实习经历中就已经这么认为了。因此,我会不惜任何代价避免使用switch/case。这主要是因为它们违反了开放闭合原则。我深深地相信,遵循这个原则是写出面向对象代码的最好实践。我不是唯一一个这样想的,Robert C. Martin曾经说:
在很多方面,开放闭合原则是面向对象设计的核心。遵循这个原则会从面向对象技术中收获巨大的好处,比如可重用性和可维护性1。
我告诉自己:“我们使用Java8或许可以发现一些新的特性来避免swtich/case的危险场面出现”。使用Java8的新 functions(不是那么新,不过你知道我的意思)。我决定使用枚举代表不同的可得到时间段。
public enum TimePeriod { MINUTE(Dimension.MINUTE, (from, to) -> Minutes.minutesBetween(from, to).getMinutes() + 1, Minutes::minutes, from -> from.withZone(DateTimeZone.UTC) .withSecondOfMinute(0) .withMillisOfSecond(0)), HOUR(Dimension.HOUR, (from, to) -> Hours.hoursBetween(from, to).getHours() + 1, Hours::hours, from -> from.withZone(DateTimeZone.UTC) .withMinuteOfHour(0) .withSecondOfMinute(0) .withMillisOfSecond(0)), DAY(Dimension.DAY, (from, to) -> Days.daysBetween(from, to).getDays() + 1, Days::days, from -> from.withZone(DateTimeZone.UTC) .withTimeAtStartOfDay()), WEEK(Dimension.WEEK, (from, to) -> Weeks.weeksBetween(from, to).getWeeks() + 1, Weeks::weeks, from -> from.withZone(DateTimeZone.UTC) .withDayOfWeek(1) .withTimeAtStartOfDay()), MONTH(Dimension.MONTH, (from, to) -> Months.monthsBetween(from, to).getMonths() + 1, Months::months, from -> from.withZone(DateTimeZone.UTC) .withDayOfMonth(1) .withTimeAtStartOfDay()); private Dimension<Timestamp> dimension; private BiFunction<DateTime, DateTime, Integer> getNumberOfPoints; private Function<Integer, ReadablePeriod> getPeriodFromNbOfInterval; private Function<DateTime, DateTime> getStartOfInterval; private TimePeriod(Dimension<Timestamp> dimension, BiFunction<DateTime, DateTime, Integer> getNumberOfPoints, Function<Integer, ReadablePeriod> getPeriodFromNbOfInterval, Function<DateTime, DateTime> getStartOfInterval) { this.dimension = dimension; this.getNumberOfPoints = getNumberOfPoints; this.getPeriodFromNbOfInterval = getPeriodFromNbOfInterval; this.getStartOfInterval = getStartOfInterval; } public Dimension<Timestamp> getDimension() { return dimension; } public int getNumberOfPoints(DateTime from, DateTime to) { return getNumberOfPoints.apply(from, to); } public ReadablePeriod getPeriodFromNbOfInterval(int nbOfInterval) { return getPeriodFromNbOfInterval.apply(nbOfInterval); } public DateTime getStartOfInterval(DateTime from) { return getStartOfInterval.apply(from); } }
通过枚举,我就能够很容易地修改代码,允许用户给图表数据点指定时间段。
原来是这样调用:
for (int i = 0; i <= Days.daysBetween(from, to).getDays(); i++)
变成这样调用:
for (int i = 0; i < timePeriod.getNumberOfPoints(from, to); i++)
支持getGraphDataPoints调用的Usage Analytics服务代码已经完成了,并且支持时间段。值得一提的是,它考虑了我之前说过的开放闭合原则。