├── .gitignore ├── .travis.yml ├── LICENSE ├── README.md ├── README_CN.md ├── google_checks.xml ├── pom.xml └── src ├── main └── java │ └── com │ └── blinkfox │ └── minitable │ └── MiniTable.java └── test └── java └── com └── blinkfox └── minitable └── MiniTableTest.java /.gitignore: -------------------------------------------------------------------------------- 1 | /target/ 2 | !.mvn/wrapper/maven-wrapper.jar 3 | 4 | ### STS ### 5 | .apt_generated 6 | .classpath 7 | .factorypath 8 | .project 9 | .settings 10 | .springBeans 11 | .sts4-cache 12 | 13 | ### IntelliJ IDEA ### 14 | .idea 15 | *.iws 16 | *.iml 17 | *.ipr 18 | 19 | ### NetBeans ### 20 | /nbproject/private/ 21 | /build/ 22 | /nbbuild/ 23 | /dist/ 24 | /nbdist/ 25 | /.nb-gradle/ -------------------------------------------------------------------------------- /.travis.yml: -------------------------------------------------------------------------------- 1 | language: java 2 | sudo: false # faster builds 3 | 4 | jdk: 5 | - oraclejdk8 6 | - openjdk7 7 | 8 | script: "mvn cobertura:cobertura" 9 | 10 | after_success: 11 | - bash <(curl -s https://codecov.io/bash) -------------------------------------------------------------------------------- /LICENSE: -------------------------------------------------------------------------------- 1 | Apache License 2 | Version 2.0, January 2004 3 | http://www.apache.org/licenses/ 4 | 5 | TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 6 | 7 | 1. Definitions. 8 | 9 | "License" shall mean the terms and conditions for use, reproduction, 10 | and distribution as defined by Sections 1 through 9 of this document. 11 | 12 | "Licensor" shall mean the copyright owner or entity authorized by 13 | the copyright owner that is granting the License. 14 | 15 | "Legal Entity" shall mean the union of the acting entity and all 16 | other entities that control, are controlled by, or are under common 17 | control with that entity. For the purposes of this definition, 18 | "control" means (i) the power, direct or indirect, to cause the 19 | direction or management of such entity, whether by contract or 20 | otherwise, or (ii) ownership of fifty percent (50%) or more of the 21 | outstanding shares, or (iii) beneficial ownership of such entity. 22 | 23 | "You" (or "Your") shall mean an individual or Legal Entity 24 | exercising permissions granted by this License. 25 | 26 | "Source" form shall mean the preferred form for making modifications, 27 | including but not limited to software source code, documentation 28 | source, and configuration files. 29 | 30 | "Object" form shall mean any form resulting from mechanical 31 | transformation or translation of a Source form, including but 32 | not limited to compiled object code, generated documentation, 33 | and conversions to other media types. 34 | 35 | "Work" shall mean the work of authorship, whether in Source or 36 | Object form, made available under the License, as indicated by a 37 | copyright notice that is included in or attached to the work 38 | (an example is provided in the Appendix below). 39 | 40 | "Derivative Works" shall mean any work, whether in Source or Object 41 | form, that is based on (or derived from) the Work and for which the 42 | editorial revisions, annotations, elaborations, or other modifications 43 | represent, as a whole, an original work of authorship. For the purposes 44 | of this License, Derivative Works shall not include works that remain 45 | separable from, or merely link (or bind by name) to the interfaces of, 46 | the Work and Derivative Works thereof. 47 | 48 | "Contribution" shall mean any work of authorship, including 49 | the original version of the Work and any modifications or additions 50 | to that Work or Derivative Works thereof, that is intentionally 51 | submitted to Licensor for inclusion in the Work by the copyright owner 52 | or by an individual or Legal Entity authorized to submit on behalf of 53 | the copyright owner. For the purposes of this definition, "submitted" 54 | means any form of electronic, verbal, or written communication sent 55 | to the Licensor or its representatives, including but not limited to 56 | communication on electronic mailing lists, source code control systems, 57 | and issue tracking systems that are managed by, or on behalf of, the 58 | Licensor for the purpose of discussing and improving the Work, but 59 | excluding communication that is conspicuously marked or otherwise 60 | designated in writing by the copyright owner as "Not a Contribution." 61 | 62 | "Contributor" shall mean Licensor and any individual or Legal Entity 63 | on behalf of whom a Contribution has been received by Licensor and 64 | subsequently incorporated within the Work. 65 | 66 | 2. Grant of Copyright License. Subject to the terms and conditions of 67 | this License, each Contributor hereby grants to You a perpetual, 68 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 69 | copyright license to reproduce, prepare Derivative Works of, 70 | publicly display, publicly perform, sublicense, and distribute the 71 | Work and such Derivative Works in Source or Object form. 72 | 73 | 3. Grant of Patent License. Subject to the terms and conditions of 74 | this License, each Contributor hereby grants to You a perpetual, 75 | worldwide, non-exclusive, no-charge, royalty-free, irrevocable 76 | (except as stated in this section) patent license to make, have made, 77 | use, offer to sell, sell, import, and otherwise transfer the Work, 78 | where such license applies only to those patent claims licensable 79 | by such Contributor that are necessarily infringed by their 80 | Contribution(s) alone or by combination of their Contribution(s) 81 | with the Work to which such Contribution(s) was submitted. If You 82 | institute patent litigation against any entity (including a 83 | cross-claim or counterclaim in a lawsuit) alleging that the Work 84 | or a Contribution incorporated within the Work constitutes direct 85 | or contributory patent infringement, then any patent licenses 86 | granted to You under this License for that Work shall terminate 87 | as of the date such litigation is filed. 88 | 89 | 4. Redistribution. You may reproduce and distribute copies of the 90 | Work or Derivative Works thereof in any medium, with or without 91 | modifications, and in Source or Object form, provided that You 92 | meet the following conditions: 93 | 94 | (a) You must give any other recipients of the Work or 95 | Derivative Works a copy of this License; and 96 | 97 | (b) You must cause any modified files to carry prominent notices 98 | stating that You changed the files; and 99 | 100 | (c) You must retain, in the Source form of any Derivative Works 101 | that You distribute, all copyright, patent, trademark, and 102 | attribution notices from the Source form of the Work, 103 | excluding those notices that do not pertain to any part of 104 | the Derivative Works; and 105 | 106 | (d) If the Work includes a "NOTICE" text file as part of its 107 | distribution, then any Derivative Works that You distribute must 108 | include a readable copy of the attribution notices contained 109 | within such NOTICE file, excluding those notices that do not 110 | pertain to any part of the Derivative Works, in at least one 111 | of the following places: within a NOTICE text file distributed 112 | as part of the Derivative Works; within the Source form or 113 | documentation, if provided along with the Derivative Works; or, 114 | within a display generated by the Derivative Works, if and 115 | wherever such third-party notices normally appear. The contents 116 | of the NOTICE file are for informational purposes only and 117 | do not modify the License. You may add Your own attribution 118 | notices within Derivative Works that You distribute, alongside 119 | or as an addendum to the NOTICE text from the Work, provided 120 | that such additional attribution notices cannot be construed 121 | as modifying the License. 122 | 123 | You may add Your own copyright statement to Your modifications and 124 | may provide additional or different license terms and conditions 125 | for use, reproduction, or distribution of Your modifications, or 126 | for any such Derivative Works as a whole, provided Your use, 127 | reproduction, and distribution of the Work otherwise complies with 128 | the conditions stated in this License. 129 | 130 | 5. Submission of Contributions. Unless You explicitly state otherwise, 131 | any Contribution intentionally submitted for inclusion in the Work 132 | by You to the Licensor shall be under the terms and conditions of 133 | this License, without any additional terms or conditions. 134 | Notwithstanding the above, nothing herein shall supersede or modify 135 | the terms of any separate license agreement you may have executed 136 | with Licensor regarding such Contributions. 137 | 138 | 6. Trademarks. This License does not grant permission to use the trade 139 | names, trademarks, service marks, or product names of the Licensor, 140 | except as required for reasonable and customary use in describing the 141 | origin of the Work and reproducing the content of the NOTICE file. 142 | 143 | 7. Disclaimer of Warranty. Unless required by applicable law or 144 | agreed to in writing, Licensor provides the Work (and each 145 | Contributor provides its Contributions) on an "AS IS" BASIS, 146 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or 147 | implied, including, without limitation, any warranties or conditions 148 | of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A 149 | PARTICULAR PURPOSE. You are solely responsible for determining the 150 | appropriateness of using or redistributing the Work and assume any 151 | risks associated with Your exercise of permissions under this License. 152 | 153 | 8. Limitation of Liability. In no event and under no legal theory, 154 | whether in tort (including negligence), contract, or otherwise, 155 | unless required by applicable law (such as deliberate and grossly 156 | negligent acts) or agreed to in writing, shall any Contributor be 157 | liable to You for damages, including any direct, indirect, special, 158 | incidental, or consequential damages of any character arising as a 159 | result of this License or out of the use or inability to use the 160 | Work (including but not limited to damages for loss of goodwill, 161 | work stoppage, computer failure or malfunction, or any and all 162 | other commercial damages or losses), even if such Contributor 163 | has been advised of the possibility of such damages. 164 | 165 | 9. Accepting Warranty or Additional Liability. While redistributing 166 | the Work or Derivative Works thereof, You may choose to offer, 167 | and charge a fee for, acceptance of support, warranty, indemnity, 168 | or other liability obligations and/or rights consistent with this 169 | License. However, in accepting such obligations, You may act only 170 | on Your own behalf and on Your sole responsibility, not on behalf 171 | of any other Contributor, and only if You agree to indemnify, 172 | defend, and hold each Contributor harmless for any liability 173 | incurred by, or claims asserted against, such Contributor by reason 174 | of your accepting any such warranty or additional liability. 175 | 176 | END OF TERMS AND CONDITIONS 177 | 178 | APPENDIX: How to apply the Apache License to your work. 179 | 180 | To apply the Apache License to your work, attach the following 181 | boilerplate notice, with the fields enclosed by brackets "{}" 182 | replaced with your own identifying information. (Don't include 183 | the brackets!) The text should be enclosed in the appropriate 184 | comment syntax for the file format. We also recommend that a 185 | file or class name and description of purpose be included on the 186 | same "printed page" as the copyright notice for easier 187 | identification within third-party archives. 188 | 189 | Copyright {yyyy} {name of copyright owner} 190 | 191 | Licensed under the Apache License, Version 2.0 (the "License"); 192 | you may not use this file except in compliance with the License. 193 | You may obtain a copy of the License at 194 | 195 | http://www.apache.org/licenses/LICENSE-2.0 196 | 197 | Unless required by applicable law or agreed to in writing, software 198 | distributed under the License is distributed on an "AS IS" BASIS, 199 | WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 200 | See the License for the specific language governing permissions and 201 | limitations under the License. 202 | -------------------------------------------------------------------------------- /README.md: -------------------------------------------------------------------------------- 1 | # mini-table 2 | 3 | [![HitCount](http://hits.dwyl.io/blinkfox/mini-table.svg)](http://hits.dwyl.io/blinkfox/mini-table) [![Build Status](https://secure.travis-ci.org/blinkfox/mini-table.svg)](https://travis-ci.org/blinkfox/mini-table) [![Javadocs](http://www.javadoc.io/badge/com.blinkfox/mini-table.svg)](http://www.javadoc.io/doc/com.blinkfox/mini-table) [![GitHub license](https://img.shields.io/github/license/blinkfox/mini-table.svg)](https://github.com/blinkfox/mini-table/blob/master/LICENSE) [![codecov](https://codecov.io/gh/blinkfox/mini-table/branch/master/graph/badge.svg)](https://codecov.io/gh/blinkfox/mini-table) [![Maven Central](https://img.shields.io/maven-central/v/com.blinkfox/mini-table.svg)](https://search.maven.org/artifact/com.blinkfox/mini-table/1.0.0/jar) ![Java Version](https://img.shields.io/badge/Java-%3E%3D%206-blue.svg) 4 | 5 | [中文文档](https://github.com/blinkfox/mini-table/blob/master/README_CN.md) 6 | 7 | > A lightweight, zero-dependency Java ASCII TABLE generation library. 8 | 9 | ## Features 10 | 11 | - Lightweight, no dependencies (jar package only `9kb`) 12 | - API is easy to use 13 | - Easy to integrate or customize modifications, only one [Java](https://github.com/blinkfox/mini-table/blob/master/src/main/java/com/blinkfox/minitable/MiniTable.java) file, and code specification 14 | 15 | ## How to use 16 | 17 | ### Maven 18 | 19 | ```xml 20 | 21 | com.blinkfox 22 | mini-table 23 | 1.0.0 24 | 25 | ``` 26 | 27 | ### API 28 | 29 | #### Demo1 (No Title) 30 | 31 | ```java 32 | String table = new MiniTable() 33 | .addHeaders("header1", "header2") 34 | .addDatas("col11", "col12") 35 | .addDatas("col21", "col22") 36 | .render(); 37 | System.out.println(table); 38 | ``` 39 | 40 | Output Result: 41 | 42 | ```bash 43 | +---------+---------+ 44 | | header1 | header2 | 45 | +---------+---------+ 46 | | col11 | col12 | 47 | | col21 | col22 | 48 | +---------+---------+ 49 | ``` 50 | 51 | #### Demo2（Titled） 52 | 53 | ```java 54 | String table = new MiniTable("The Title") 55 | .addHeaders("Name", "Sex", "Age", "Email", "Phone") 56 | .addDatas("LiLei", "male", 25, "lilei@gmail.com", "13809345219") 57 | .addDatas("hanMeiMei", "female", 23, "hmm@163.com", "13515343853") 58 | .addDatas("ZhangSan", "female", 32, "zhangsan@gmail.com", "13920199836") 59 | .render(); 60 | System.out.println(table); 61 | ``` 62 | 63 | Output Result: 64 | 65 | ```bash 66 | +-------------------------------------------------------------+ 67 | | The Title | 68 | +-----------+--------+-----+--------------------+-------------+ 69 | | Name | Sex | Age | Email | Phone | 70 | +-----------+--------+-----+--------------------+-------------+ 71 | | LiLei | male | 25 | lilei@gmail.com | 13809345219 | 72 | | hanMeiMei | female | 23 | hmm@163.com | 13515343853 | 73 | | ZhangSan | female | 32 | zhangsan@gmail.com | 13920199836 | 74 | +-----------+--------+-----+--------------------+-------------+ 75 | ``` 76 | 77 | ## License 78 | 79 | This [mini-table](https://github.com/blinkfox/mini-table) library is open sourced under the [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0). 80 | -------------------------------------------------------------------------------- /README_CN.md: -------------------------------------------------------------------------------- 1 | # mini-table 2 | 3 | [![HitCount](http://hits.dwyl.io/blinkfox/mini-table.svg)](http://hits.dwyl.io/blinkfox/mini-table) [![Build Status](https://secure.travis-ci.org/blinkfox/mini-table.svg)](https://travis-ci.org/blinkfox/mini-table) [![Javadocs](http://www.javadoc.io/badge/com.blinkfox/mini-table.svg)](http://www.javadoc.io/doc/com.blinkfox/mini-table) [![GitHub license](https://img.shields.io/github/license/blinkfox/mini-table.svg)](https://github.com/blinkfox/mini-table/blob/master/LICENSE) [![codecov](https://codecov.io/gh/blinkfox/mini-table/branch/master/graph/badge.svg)](https://codecov.io/gh/blinkfox/mini-table) [![Maven Central](https://img.shields.io/maven-central/v/com.blinkfox/mini-table.svg)](https://search.maven.org/artifact/com.blinkfox/mini-table/1.0.0/jar) ![Java Version](https://img.shields.io/badge/Java-%3E%3D%206-blue.svg) 4 | 5 | [English Document](https://github.com/blinkfox/mini-table/blob/master/README.md) 6 | 7 | > 一个轻量级、零依赖的 Java ASCII 表格生成库。 8 | 9 | ## 特性 10 | 11 | - 轻量级、无依赖（jar包仅`9kb`） 12 | - API简单易用 13 | - 易于集成或定制修改，仅一个[Java](https://github.com/blinkfox/mini-table/blob/master/src/main/java/com/blinkfox/minitable/MiniTable.java)文件，且代码规范 14 | 15 | ## 集成使用 16 | 17 | ### Maven集成 18 | 19 | ```xml 20 | 21 | com.blinkfox 22 | mini-table 23 | 1.0.0 24 | 25 | ``` 26 | 27 | ### API 使用 28 | 29 | #### 示例1（无标题） 30 | 31 | ```java 32 | String table = new MiniTable() 33 | .addHeaders("header1", "header2") 34 | .addDatas("col11", "col12") 35 | .addDatas("col21", "col22") 36 | .render(); 37 | System.out.println(table); 38 | ``` 39 | 40 | 输出结果: 41 | 42 | ```bash 43 | +---------+---------+ 44 | | header1 | header2 | 45 | +---------+---------+ 46 | | col11 | col12 | 47 | | col21 | col22 | 48 | +---------+---------+ 49 | ``` 50 | 51 | #### 示例2（有标题） 52 | 53 | ```java 54 | String table = new MiniTable("The Title") 55 | .addHeaders("Name", "Sex", "Age", "Email", "Phone") 56 | .addDatas("LiLei", "male", 25, "lilei@gmail.com", "13809345219") 57 | .addDatas("hanMeiMei", "female", 23, "hmm@163.com", "13515343853") 58 | .addDatas("ZhangSan", "female", 32, "zhangsan@gmail.com", "13920199836") 59 | .render(); 60 | System.out.println(table); 61 | ``` 62 | 63 | 输出结果: 64 | 65 | ```bash 66 | +-------------------------------------------------------------+ 67 | | The Title | 68 | +-----------+--------+-----+--------------------+-------------+ 69 | | Name | Sex | Age | Email | Phone | 70 | +-----------+--------+-----+--------------------+-------------+ 71 | | LiLei | male | 25 | lilei@gmail.com | 13809345219 | 72 | | hanMeiMei | female | 23 | hmm@163.com | 13515343853 | 73 | | ZhangSan | female | 32 | zhangsan@gmail.com | 13920199836 | 74 | +-----------+--------+-----+--------------------+-------------+ 75 | ``` 76 | 77 | ## 许可证 78 | 79 | 本 [mini-table](https://github.com/blinkfox/mini-table) 类库遵守 [Apache License 2.0](http://www.apache.org/licenses/LICENSE-2.0) 许可证。 80 | -------------------------------------------------------------------------------- /google_checks.xml: -------------------------------------------------------------------------------- 1 | 2 | 5 | 6 | 14 | 15 | 16 | 17 | 18 | 19 | 20 | 21 | 22 | 23 | 24 | 25 | 26 | 27 | 28 | 29 | 30 | 31 | 33 | 35 | 36 | 37 | 38 | 39 | 40 | 41 | 42 | 43 | 44 | 45 | 46 | 47 | 48 | 49 | 50 | 52 | 53 | 54 | 55 | 56 | 57 | 60 | 61 | 62 | 63 | 64 | 67 | 68 | 69 | 70 | 71 | 72 | 73 | 75 | 77 | 78 | 79 | 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | 91 | 92 | 93 | 94 | 95 | 96 | 97 | 98 | 99 | 100 | 101 | 102 | 103 | 104 | 105 | 106 | 107 | 108 | 109 | 110 | 111 | 112 | 113 | 114 | 115 | 116 | 117 | 119 | 120 | 121 | 123 | 124 | 125 | 126 | 128 | 129 | 130 | 131 | 133 | 134 | 135 | 136 | 138 | 139 | 140 | 141 | 143 | 144 | 145 | 146 | 147 | 149 | 150 | 151 | 152 | 154 | 155 | 156 | 157 | 159 | 160 | 161 | 162 | 164 | 165 | 166 | 167 | 169 | 171 | 173 | 175 | 176 | 177 | 178 | 179 | 180 | 181 | 182 | 183 | 184 | 185 | 186 | 187 | 188 | 189 | 190 | 191 | 192 | 193 | 194 | 195 | 196 | 197 | 199 | 200 | 201 | 202 | 203 | 204 | 207 | 208 | 209 | 210 | 212 | 213 | 214 | 215 | 216 | 217 | 218 | 219 | 220 | 221 | 223 | 224 | 225 | 226 | 227 | 229 | 230 | 231 | 232 | 233 | 234 | 235 | 236 | 237 | 238 | 239 | 240 | 241 | 243 | 244 | 245 | 246 | 247 | 248 | 249 | 250 | 251 | 252 | 253 | -------------------------------------------------------------------------------- /pom.xml: -------------------------------------------------------------------------------- 1 | 2 | 4 | 4.0.0 5 | 6 | com.blinkfox 7 | mini-table 8 | 1.0.0 9 | jar 10 | 11 | mini-table 12 | A lightweight, non-dependent Java ASCII TABLE generation library. 13 | https://github.com/blinkfox/mini-table 14 | 15 | 16 | 17 | The Apache Software License, Version 2.0 18 | http://www.apache.org/licenses/LICENSE-2.0.txt 19 | 20 | 21 | 22 | 23 | 24 | blinkfox 25 | chenjiayin1990@163.com 26 | https://blinkfox.github.io/ 27 | 28 | 29 | 30 | 31 | scm:git@github.com:blinkfox/mini-table.git 32 | scm:git@github.com:blinkfox/mini-table.git 33 | https://github.com/blinkfox/mini-table 34 | 35 | 36 | 37 | UTF-8 38 | UTF-8 39 | UTF-8 40 | 41 | 42 | 43 | 44 | junit 45 | junit 46 | 4.13.1 47 | test 48 | 49 | 50 | 51 | 52 | 53 | 54 | org.apache.maven.plugins 55 | maven-compiler-plugin 56 | 2.3.2 57 | 58 | 1.6 59 | 1.6 60 | UTF-8 61 | 62 | 63 | 64 | org.apache.maven.plugins 65 | maven-pmd-plugin 66 | 3.7 67 | 68 | 1.6 69 | true 70 | 71 | 72 | 73 | org.codehaus.mojo 74 | cobertura-maven-plugin 75 | 2.7 76 | 77 | 78 | html 79 | xml 80 | 81 | 82 | 83 | 84 | 85 | 86 | 87 | 88 | 89 | 90 | org.apache.maven.plugins 91 | maven-project-info-reports-plugin 92 | 2.9 93 | 94 | 95 | org.apache.maven.plugins 96 | maven-pmd-plugin 97 | 3.7 98 | 99 | 100 | org.apache.maven.plugins 101 | maven-jxr-plugin 102 | 2.5 103 | 104 | 105 | org.codehaus.mojo 106 | cobertura-maven-plugin 107 | 2.7 108 | 109 | 110 | html 111 | xml 112 | 113 | 114 | 115 | 116 | 117 | 118 | 119 | 120 | 121 | release 122 | 123 | 124 | 125 | 126 | org.apache.maven.plugins 127 | maven-source-plugin 128 | 3.0.1 129 | 130 | 131 | package 132 | 133 | jar-no-fork 134 | 135 | 136 | 137 | 138 | 139 | 140 | org.apache.maven.plugins 141 | maven-javadoc-plugin 142 | 2.10.4 143 | 144 | 145 | package 146 | 147 | jar 148 | 149 | 150 | 151 | 152 | 153 | 154 | org.apache.maven.plugins 155 | maven-gpg-plugin 156 | 1.6 157 | 158 | 159 | verify 160 | 161 | sign 162 | 163 | 164 | 165 | 166 | 167 | 168 | 169 | 170 | oss 171 | https://oss.sonatype.org/content/repositories/snapshots/ 172 | 173 | 174 | oss 175 | https://oss.sonatype.org/service/local/staging/deploy/maven2/ 176 | 177 | 178 | 179 | 180 | 181 | 182 | 183 | oss 184 | https://oss.sonatype.org/content/repositories/snapshots/ 185 | 186 | 187 | oss 188 | https://oss.sonatype.org/service/local/staging/deploy/maven2/ 189 | 190 | 191 | 192 | 193 | -------------------------------------------------------------------------------- /src/main/java/com/blinkfox/minitable/MiniTable.java: -------------------------------------------------------------------------------- 1 | package com.blinkfox.minitable; 2 | 3 | import java.util.ArrayList; 4 | import java.util.HashMap; 5 | import java.util.List; 6 | import java.util.Map; 7 | 8 | /** 9 | * 生成 ASCII TABLE 的主核心类. 10 | * 11 | * @author blinkfox on 2019-01-13. 12 | */ 13 | public final class MiniTable { 14 | 15 | /** 表格标题. */ 16 | private String title; 17 | 18 | /** 最后处理行类型. */ 19 | private RowType lastRowType; 20 | 21 | /** 用于拼接字符串的 StringBuilder 对象. */ 22 | private StringBuilder join; 23 | 24 | /** 用来存放每行数据的有序Map. */ 25 | private List rows; 26 | 27 | /** 用来存放每列长度最大值的Map. */ 28 | private Map maxColMap; 29 | 30 | /** 31 | * 默认的空构造方法. 32 | */ 33 | public MiniTable() { 34 | this.init(); 35 | } 36 | 37 | /** 38 | * 包含标题的构造方法. 39 | * 40 | * @param title 标题 41 | */ 42 | public MiniTable(String title) { 43 | this.init(); 44 | this.title = title; 45 | } 46 | 47 | /** 48 | * 初始化数据. 49 | */ 50 | private void init() { 51 | this.join = new StringBuilder(); 52 | this.rows = new ArrayList(); 53 | this.maxColMap = new HashMap(); 54 | } 55 | 56 | /** 57 | * 将集合中的元素添加到表格中的表头数据中. 58 | * 59 | * @param headers 表头数据 60 | * @return MiniTable对象 61 | */ 62 | public MiniTable addHeaders(List headers) { 63 | return this.appendRows(RowType.HEADER, headers.toArray()); 64 | } 65 | 66 | /** 67 | * 向表格中添加表头数据. 68 | * 69 | * @param objects 表头数据 70 | * @return MiniTable对象 71 | */ 72 | public MiniTable addHeaders(Object... objects) { 73 | return this.appendRows(RowType.HEADER, objects); 74 | } 75 | 76 | /** 77 | * 向表格中添加一行普通数据. 78 | * 79 | * @param datas 普通行数据 80 | * @return MiniTable对象 81 | */ 82 | public MiniTable addDatas(List datas) { 83 | return this.appendRows(RowType.DATA, datas.toArray()); 84 | } 85 | 86 | /** 87 | * 向表格中添加一行普通数据. 88 | * 89 | * @param objects 普通行数据 90 | * @return MiniTable对象 91 | */ 92 | public MiniTable addDatas(Object... objects) { 93 | return this.appendRows(RowType.DATA, objects); 94 | } 95 | 96 | /** 97 | * 向表格添加中一行数据. 98 | * 99 | * @param objects 表行数据 100 | * @return MiniTable对象 101 | */ 102 | private MiniTable appendRows(RowType rowType, Object... objects) { 103 | int len; 104 | if (objects != null && (len = objects.length) > 0) { 105 | if (this.maxColMap.size() > len) { 106 | throw new IllegalArgumentException("向表格中插入某行数据的列数与之前的列数不同,请检查!"); 107 | } 108 | 109 | // 遍历传入的数据集合，并将其存入到行数据对象中. 110 | List datas = new ArrayList(); 111 | for (int i = 0; i < len; i++) { 112 | Object o = objects[i]; 113 | String value = o == null ? "null" : o.toString(); 114 | datas.add(value); 115 | 116 | // 获取第 i 列的最大长度值，如果该列数据不存在，就存储起来. 117 | Integer maxColSize = this.maxColMap.get(i); 118 | if (maxColSize == null) { 119 | this.maxColMap.put(i, value.length()); 120 | continue; 121 | } 122 | 123 | // 如果当前列的长度大于了以前的最大列，就覆盖最大列长度为当前的列长度. 124 | if (value.length() > maxColSize) { 125 | this.maxColMap.put(i, value.length()); 126 | } 127 | } 128 | this.rows.add(new Row(rowType, datas)); 129 | } 130 | return this; 131 | } 132 | 133 | /** 134 | * 构建表格标题所在行的字符串. 135 | * 136 | *

这里重点需要计算出标题所占用的最大字符串长度，然后截取出标题的字符串. 137 | * 计算标题字符串最大长度的公式: `maxTitleSize = n * (maxColSize) + (n - 1) * 3`; 138 | *

139 | */ 140 | private void buildTitle() { 141 | if (this.title != null) { 142 | // 计算出标题字符串最大长度. 143 | int maxTitleSize = 0; 144 | for (Integer maxColSize : this.maxColMap.values()) { 145 | maxTitleSize += maxColSize; 146 | } 147 | maxTitleSize += 3 * (this.maxColMap.size() - 1); 148 | 149 | // 如果最大的标题字符串长度大于了现有的标题，就对现有的标题进行截取. 150 | if (this.title.length() > maxTitleSize) { 151 | this.title = this.title.substring(0, maxTitleSize); 152 | } 153 | 154 | // 拼接出标题行的上边框和标题行的数据. 155 | this.join.append("+"); 156 | for (int i = 0; i < maxTitleSize + 2; i++) { 157 | this.join.append("-"); 158 | } 159 | this.join.append("+\n") 160 | .append("|") 161 | .append(StrUtils.center(this.title, maxTitleSize + 2, ' ')) 162 | .append("|\n"); 163 | 164 | this.lastRowType = RowType.TITLE; 165 | } 166 | } 167 | 168 | /** 169 | * 构建生成表格 table，先构建出标题，然后遍历每行数据进行构建. 170 | */ 171 | private void buildTable() { 172 | this.buildTitle(); 173 | 174 | // 遍历每行的数据，生成表格的行数据. 175 | for (int i = 0, len = this.rows.size(); i < len; i++) { 176 | List datas = this.rows.get(i).datas; 177 | switch (this.rows.get(i).rowType) { 178 | // 如果当前行是表头，则需要考虑生成上下边框. 179 | case HEADER: 180 | if (this.lastRowType != RowType.HEADER) { 181 | this.buildRowBorder(datas); 182 | } 183 | this.buildRowData(datas); 184 | this.buildRowBorder(datas); 185 | break; 186 | // 如果当前行是普通数据行，则需要考虑在最后一行处追加下边框. 187 | case DATA: 188 | this.buildRowData(datas); 189 | if (i == len - 1) { 190 | this.buildRowBorder(datas); 191 | } 192 | break; 193 | default: 194 | break; 195 | } 196 | } 197 | } 198 | 199 | /** 200 | * 构建边框行的方法. 201 | * 202 | * @param datas 行 203 | */ 204 | private void buildRowBorder(List datas) { 205 | this.join.append("+"); 206 | for (int i = 0, len = datas.size(); i < len; i++) { 207 | for (int j = 0; j < this.maxColMap.get(i) + 2; j++) { 208 | this.join.append("-"); 209 | } 210 | this.join.append("+"); 211 | } 212 | this.join.append("\n"); 213 | } 214 | 215 | /** 216 | * 构建数据行的方法. 217 | * 218 | * @param datas 行数据 219 | */ 220 | private void buildRowData(List datas) { 221 | this.join.append("|"); 222 | for (int i = 0, len = datas.size(); i < len; i++) { 223 | this.join.append(StrUtils.center(datas.get(i), this.maxColMap.get(i) + 2, ' ')) 224 | .append("|"); 225 | } 226 | this.join.append("\n"); 227 | } 228 | 229 | /** 230 | * 渲染出生成的结果. 231 | * 232 | * @return Table的ASCII字符串 233 | */ 234 | public String render() { 235 | this.buildTable(); 236 | return this.join.toString(); 237 | } 238 | 239 | /** 240 | * 表格每行的类型和数据的实体类. 241 | */ 242 | private static class Row { 243 | 244 | /** 行类型. */ 245 | private RowType rowType; 246 | 247 | /** 行数据. */ 248 | private List datas; 249 | 250 | /** 251 | * 构造方法. 252 | * 253 | * @param rowType 行类型 254 | * @param datas 行数据集 255 | */ 256 | Row(RowType rowType, List datas) { 257 | this.rowType = rowType; 258 | this.datas = datas; 259 | } 260 | 261 | } 262 | 263 | /** 264 | * 区分是表头还是普通表格数据的枚举类. 265 | */ 266 | private enum RowType { 267 | TITLE, HEADER, DATA 268 | } 269 | 270 | /** 271 | * 字符串工具类. 272 | */ 273 | private static final class StrUtils { 274 | 275 | /** 276 | * 将某字符串置于给定大小的中间. 277 | * 278 | * @param str 字符串 279 | * @param size 总大小 280 | * @param padChar 填充字符 281 | * @return 字符串结果 282 | */ 283 | private static String center(String str, int size, char padChar) { 284 | if (str != null && size > 0) { 285 | int strLen = str.length(); 286 | int pads = size - strLen; 287 | if (pads > 0) { 288 | str = leftPad(str, strLen + pads / 2, padChar); 289 | str = rightPad(str, size, padChar); 290 | } 291 | } 292 | return str; 293 | } 294 | 295 | /** 296 | * 对给定的字符串和大小进行左填充. 297 | * 298 | * @param str 字符串 299 | * @param size 填充的总大小 300 | * @param padChar 填充字符 301 | * @return 填充结果 302 | */ 303 | private static String leftPad(final String str, int size, char padChar) { 304 | int pads = size - str.length(); 305 | return pads <= 0 ? str : repeat(padChar, pads).concat(str); 306 | } 307 | 308 | /** 309 | * 对给定的字符串和大小进行右填充. 310 | * 311 | * @param str 字符串 312 | * @param size 填充的总大小 313 | * @param padChar 填充字符 314 | * @return 填充结果 315 | */ 316 | private static String rightPad(final String str, int size, char padChar) { 317 | int pads = size - str.length(); 318 | return pads <= 0 ? str : str.concat(repeat(padChar, pads)); 319 | } 320 | 321 | /** 322 | * 重复填充字符为字符串. 323 | * 324 | * @param ch 字符 325 | * @param repeat 重复次数 326 | * @return 字符串 327 | */ 328 | private static String repeat(char ch, int repeat) { 329 | char[] buf = new char[repeat]; 330 | for (int i = repeat - 1; i >= 0; i--) { 331 | buf[i] = ch; 332 | } 333 | return new String(buf); 334 | } 335 | 336 | } 337 | 338 | } 339 | -------------------------------------------------------------------------------- /src/test/java/com/blinkfox/minitable/MiniTableTest.java: -------------------------------------------------------------------------------- 1 | package com.blinkfox.minitable; 2 | 3 | import java.util.ArrayList; 4 | import java.util.List; 5 | 6 | import org.junit.Assert; 7 | import org.junit.Test; 8 | 9 | /** 10 | * MiniTableTest. 11 | * 12 | * @author blinkfox on 2019-01-13. 13 | */ 14 | public class MiniTableTest { 15 | 16 | private static final String TABLE = "" 17 | + "+-------------------------------------------------------------+\n" 18 | + "| The Title |\n" 19 | + "+-----------+--------+-----+--------------------+-------------+\n" 20 | + "| Name | Sex | Age | Email | Phone |\n" 21 | + "+-----------+--------+-----+--------------------+-------------+\n" 22 | + "| LiLei | male | 25 | lilei@gmail.com | 13809345219 |\n" 23 | + "| hanMeiMei | female | 23 | hmm@163.com | 13515343853 |\n" 24 | + "+-----------+--------+-----+--------------------+-------------+\n" 25 | + "| Name | Sex | Age | Email | Phone |\n" 26 | + "+-----------+--------+-----+--------------------+-------------+\n" 27 | + "| ZhangSan | female | 32 | zhangsan@gmail.com | 13920199836 |\n" 28 | + "| Lisi | male | 28 | lisi@qq.com | 13635781534 |\n" 29 | + "| WangWu | male | 48 | wangwu@163.com | 15809876236 |\n" 30 | + "+-----------+--------+-----+--------------------+-------------+\n"; 31 | 32 | /** 33 | * 测试正常渲染的情况. 34 | */ 35 | @Test 36 | public void render() { 37 | // 构造一行List集合类型的普通数据，用于测试List集合数据的添加. 38 | List rowDatas = new ArrayList(); 39 | rowDatas.add("WangWu"); 40 | rowDatas.add("male"); 41 | rowDatas.add(48); 42 | rowDatas.add("wangwu@163.com"); 43 | rowDatas.add("15809876236"); 44 | 45 | String table = new MiniTable("The Title") 46 | .addHeaders("Name", "Sex", "Age", "Email", "Phone") 47 | .addDatas("LiLei", "male", 25, "lilei@gmail.com", "13809345219") 48 | .addDatas("hanMeiMei", "female", 23, "hmm@163.com", "13515343853") 49 | .addHeaders("Name", "Sex", "Age", "Email", "Phone") 50 | .addDatas("ZhangSan", "female", 32, "zhangsan@gmail.com", "13920199836") 51 | .addDatas("Lisi", "male", 28, "lisi@qq.com", "13635781534") 52 | .addDatas(rowDatas) 53 | .render(); 54 | Assert.assertEquals(TABLE, table); 55 | } 56 | 57 | /** 58 | * 测试参数不对时的情况. 59 | */ 60 | @Test(expected = IllegalArgumentException.class) 61 | public void renderWithException() { 62 | new MiniTable().addHeaders("col11", "col12") 63 | .addDatas("col21") 64 | .render(); 65 | } 66 | 67 | /** 68 | * 测试参数不对时的情况. 69 | */ 70 | @Test 71 | public void renderWithLongTitle() { 72 | List headers = new ArrayList(); 73 | headers.add(12345); 74 | headers.add("abcde"); 75 | 76 | String table = new MiniTable("This is a too long title.") 77 | .addHeaders(headers) 78 | .render(); 79 | Assert.assertEquals("" 80 | + "+---------------+\n" 81 | + "| This is a too |\n" 82 | + "+-------+-------+\n" 83 | + "| 12345 | abcde |\n" 84 | + "+-------+-------+\n", table); 85 | } 86 | 87 | } --------------------------------------------------------------------------------