com.feilong.formatter.SimpleTableFormatter Maven / Gradle / Ivy
Go to download
Show more of this group Show more artifacts with this name
Show all versions of feilong Show documentation
Show all versions of feilong Show documentation
feilong is a suite of core and expanded libraries that include utility classes, http, excel,cvs, io classes, and much much more.
/*
* Copyright (C) 2008 feilong
*
* Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License.
* You may obtain a copy of the License at
*
* http://www.apache.org/licenses/LICENSE-2.0
*
* Unless required by applicable law or agreed to in writing, software
* distributed under the License is distributed on an "AS IS" BASIS,
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
* See the License for the specific language governing permissions and
* limitations under the License.
*/
package com.feilong.formatter;
import static com.feilong.core.Validator.isNullOrEmpty;
import static com.feilong.core.date.DateUtil.formatDuration;
import static com.feilong.core.date.DateUtil.now;
import static com.feilong.core.lang.ArrayUtil.newArray;
import static com.feilong.core.lang.StringUtil.SPACE;
import static com.feilong.core.util.CollectionsUtil.addAllIgnoreNull;
import static com.feilong.core.util.CollectionsUtil.newArrayList;
import static com.feilong.lib.collection4.CollectionUtils.addIgnoreNull;
import static com.feilong.core.lang.StringUtil.EMPTY;
import static com.feilong.lib.lang3.StringUtils.defaultString;
import static java.lang.System.lineSeparator;
import java.util.Date;
import java.util.List;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import com.feilong.core.bean.ConvertUtil;
import com.feilong.formatter.builder.ColumnMaxWidthsBuilder;
import com.feilong.lib.lang3.StringUtils;
/**
* 简单的格式化成table的实现.
*
*
* 简单的table 会渲染标题 和分隔符,不包含 padding margin等设定,也不支持复杂的组合表格设置
*
*
* 初衷:
*
*
*
* 在做开发的时候,我们经常会记录一些日志,使用log,但是对于 list map ,bean的日志输出一直很难做得很好,为了格式化输出,我们可能会使用 json来输出,比如:
*
*
*
* List{@code } list = toList(
* new Address("china", "shanghai", "wenshui wanrong.lu 888", "216000"),
* new Address("china", "beijing", "wenshui wanrong.lu 666", "216001"),
* new Address("china", "nantong", "wenshui wanrong.lu 222", "216002"),
* new Address("china", "tianjing", "wenshui wanrong.lu 999", "216600"));
*
* LOGGER.debug(JsonUtil.format(list));
*
*
* 结果:
*
*
[{
"zipCode": "wenshui wanrong.lu 888",
"addr": "216000",
"country": "china",
"city": "shanghai"
},
{
"zipCode": "wenshui wanrong.lu 666",
"addr": "216001",
"country": "china",
"city": "beijing"
},
{
"zipCode": "wenshui wanrong.lu 222",
"addr": "216002",
"country": "china",
"city": "nantong"
},
{
"zipCode": "wenshui wanrong.lu 999",
"addr": "216600",
"country": "china",
"city": "tianjing"
}]
*
*
*
* 可以看出,结果难以阅读,如果list元素更多一些,那么更加难以阅读;
*
*
*
*
*
* 解决方案:
*
*
*
*
* 这个时候可以使用
*
*
*
* List{@code } list = toList(
* new Address("china", "shanghai", "wenshui wanrong.lu 888", "216000"),
* new Address("china", "beijing", "wenshui wanrong.lu 666", "216001"),
* new Address("china", "nantong", "wenshui wanrong.lu 222", "216002"),
* new Address("china", "tianjing", "wenshui wanrong.lu 999", "216600"));
*
* LOGGER.debug(formatToSimpleTable(list));
*
*
*
* 结果:
*
*
addr city country zipCode
------ -------- ------- ----------------------
216000 shanghai china wenshui wanrong.lu 888
216001 beijing china wenshui wanrong.lu 666
216002 nantong china wenshui wanrong.lu 222
216600 tianjing china wenshui wanrong.lu 999
*
*
*
* 可以看出,输出的结果会更加友好
*
*
*
*
* 说明:
*
*
* - 为了方便使用,可以直接使用 {@link FormatterUtil} 工具类
* - 不建议format 太多的数据,以容易查看为原则
* - 如果字段含有中文,显示可能会错位,你可以尝试将结果进行 replace(SPACE, "\u3000") 处理,参见
* format Chinese
* characters
*
*
*
* @author feilong
* @since 1.8.5
*/
public class SimpleTableFormatter extends AbstractFormatter{
/** The Constant log. */
private static final Logger LOGGER = LoggerFactory.getLogger(SimpleTableFormatter.class);
//---------------------------------------------------------------
/*
* (non-Javadoc)
*
* @see com.feilong.coreextension.formatter.Formatter#format(java.lang.String[], java.util.List)
*/
@Override
public String format(String[] columnTitles,List dataList){
Date beginDate = now();
//---------------------------------------------------------------
List rows = combinRowsData(columnTitles, dataList);
if (isNullOrEmpty(rows)){
return EMPTY;
}
//---------------------------------------------------------------
int[] colWidths = ColumnMaxWidthsBuilder.build(rows);
if (null != columnTitles){
insertSplitorLine(rows, colWidths);
}
//---------------------------------------------------------------
StringBuilder sb = new StringBuilder();
for (Object[] cells : rows){
sb.append(formatRowInfo(cells, colWidths)).append(lineSeparator());
}
//---------------------------------------------------------------
if (LOGGER.isDebugEnabled()){
LOGGER.debug("format use time:[{}]", formatDuration(beginDate));
}
return lineSeparator() + sb.toString();
}
//---------------------------------------------------------------
/**
* Format row info.
*
* @param cells
* 所有的单元格
* @param colWidths
* the col widths
* @return the string builder
* @since 1.8.3
*/
private static StringBuilder formatRowInfo(Object[] cells,int[] colWidths){
StringBuilder sb = new StringBuilder();
for (int colNum = 0; colNum < cells.length; colNum++){
sb.append(StringUtils.rightPad(defaultString(ConvertUtil.toString(cells[colNum])), colWidths[colNum]));
sb.append(SPACE);
}
return sb;
}
/**
* 插入分隔符行.
*
* @param rows
* the rows
* @param colWidths
* the col widths
* @since 1.8.3
*/
private static void insertSplitorLine(List rows,int[] colWidths){
String[] borders = newArray(String.class, colWidths.length);
for (int i = 0; i < borders.length; ++i){
borders[i] = StringUtils.repeat("-", colWidths[i]);
}
rows.add(1, borders);
}
//---------------------------------------------------------------
/**
* 组合头和数据行.
*
* @param columnTitles
* the column titles
* @param dataList
* the data list
* @return 如果 null==columnTitles,将忽略
* 如果 null==dataList,将忽略
* @since 1.8.2
*/
private static List combinRowsData(String[] columnTitles,List dataList){
List rows = newArrayList();
addIgnoreNull(rows, columnTitles);
addAllIgnoreNull(rows, dataList);
return rows;
}
}