Skip to content

Commit fecc0c2

Browse files
dunwudunwu
committed
update docs
1 parent 914e6ae commit fecc0c2

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

42 files changed

+2028
-1297
lines changed

‎.gitignore‎

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -29,6 +29,7 @@ hs_err_pid*
2929

3030
# maven plugin temp files
3131
.flattened-pom.xml
32+
package-lock.json
3233

3334

3435
# ------------------------------- javascript -------------------------------
@@ -47,6 +48,7 @@ npm-debug.log*
4748
yarn-debug.log*
4849
yarn-error.log*
4950
bundle*.js
51+
book.pdf
5052

5153

5254
# ------------------------------- intellij -------------------------------

‎README.md‎

Lines changed: 27 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -9,36 +9,42 @@
99

1010
> 各种主流 Java 库的应用。
1111
12-
- [Dozer 使用指南](docs/javalib/dozer.md)
13-
- [Freemark 使用指南](docs/javalib/freemark.md)
12+
- [Dozer 应用指南](docs/javalib/dozer.md)
13+
- [Freemark 应用指南](docs/javalib/freemark.md)
1414
- [Java 与 JSON](docs/javalib/javalib-json.md)
15-
- [细说 Java 主流日志工具库](docs/javalib/java-log.md)
16-
- [细说 Java 主流工具包](docs/javalib/java-util.md)
17-
- [JavaMail 使用指南](docs/javalib/javamail.md)
18-
- [Jsoup 使用指南](docs/javalib/jsoup.md)
19-
- [JUnit5 使用指南](docs/javalib/junit.md)
20-
- [Lombok 使用指南](docs/javalib/lombok.md)
21-
- [Mockito 使用指南](docs/javalib/mockito.md)
22-
- [Reflections 使用指南](docs/javalib/reflections.md)
23-
- [Thumbnailator 使用指南](docs/javalib/thumbnailator.md)
24-
- [ZXing 使用指南](docs/javalib/zxing.md)
15+
- [细说 Java 主流日志工具库](docs/javalib/javalib-log.md)
16+
- [细说 Java 主流工具包](docs/javalib/javalib-util.md)
17+
- [JavaMail 应用指南](docs/javalib/javamail.md)
18+
- [Jsoup 应用指南](docs/javalib/jsoup.md)
19+
- [JUnit5 应用指南](docs/javalib/junit.md)
20+
- [Lombok 应用指南](docs/javalib/lombok.md)
21+
- [Mockito 应用指南](docs/javalib/mockito.md)
22+
- [Reflections 应用指南](docs/javalib/reflections.md)
23+
- [Thumbnailator 应用指南](docs/javalib/thumbnailator.md)
24+
- [ZXing 应用指南](docs/javalib/zxing.md)
2525

2626
## [JavaTool](docs/javatool/README.md)
2727

2828
> 各种主流 Java 工具的应用。
2929
3030
- [构建工具](docs/javatool/build/README.md)
31-
- Maven 教程
31+
- [Maven 教程 📚](docs/javatool/build/maven/README.md)
3232
- [Maven 快速指南](docs/javatool/build/maven/maven-quickstart.md)
3333
- [Maven 教程之 pom.xml 详解](docs/javatool/build/maven/maven-pom.md)
3434
- [Maven 教程之 settings.xml 详解](docs/javatool/build/maven/maven-settings.md)
3535
- [Maven 实战问题和最佳实践](docs/javatool/build/maven/maven-action.md)
3636
- [Maven 教程之发布 jar 到私服或中央仓库](docs/javatool/build/maven/maven-deploy.md)
37-
- [Maven 插件之代码检查](docs/javatool/build/maven/plugins/maven-checkstyle.md)
37+
- [Maven 插件之代码检查](docs/javatool/build/maven/maven-checkstyle-plugin.md)
3838
- [Ant 简易教程](docs/javatool/build/ant.md)
39-
- Java IDE
40-
- [Intellij IDEA 使用指南](docs/javatool/ide/intellij.md)
41-
- [Eclipse 使用指南](docs/javatool/ide/eclipse.md)
39+
- [搜索引擎 Elastic](docs/javatool/elastic/README.md)
40+
- [Elastic 技术栈快速入门](docs/javatool/elastic/elastic-quickstart.md)
41+
- [Elasticsearch 运维](docs/javatool/elastic/elastic-elasticsearch-ops.md)
42+
- [Beats 运维](docs/javatool/elastic/elastic-beats-ops.md)
43+
- [Kibana 运维](docs/javatool/elastic/elastic-kibana-ops.md)
44+
- [Logstash 运维](docs/javatool/elastic/elastic-logstash-ops.md)
45+
- [Java IDE](docs/javatool/ide/README.md)
46+
- [Intellij IDEA 应用指南](docs/javatool/ide/intellij.md)
47+
- [Eclipse 应用指南](docs/javatool/ide/eclipse.md)
4248
- **测试**
4349
- [Jmeter 应用指南](docs/javatool/test/jmeter.md)
4450

@@ -62,10 +68,10 @@
6268

6369
## 相关技术栈
6470

65-
- :1234: [db-tutorial](https://dunwu.github.io/db-tutorial/) - 是对数据库领域开发经验的总结。内容包含：关系型数据库和 Nosql 理论、Mysql、Redis 等。
66-
- :dart: [algorithm-tutorial](https://dunwu.github.io/algorithm-tutorial/) - 是对数据结构和算法的总结。内容包含：一些基本的数据结构、算法。
67-
- :penguin: [linux-tutorial](https://github.com/dunwu/linux-tutorial) - 是对 Linux 操作系统的经验总结。内容包含：Linux 常用命令；各种常见软件的 Linux 环境安装配置；运维、部署脚本；Shell、Python 语法教程；Git、Docker 教程。
68-
- :art: [frontend-tutorial](https://github.com/dunwu/frontend-tutorial) - 前端教程
71+
- [db-tutorial](https://dunwu.github.io/db-tutorial/) - 是对数据库领域开发经验的总结。内容包含：关系型数据库和 Nosql 理论、Mysql、Redis 等。
72+
- [algorithm-tutorial](https://dunwu.github.io/algorithm-tutorial/) - 是对数据结构和算法的总结。内容包含：一些基本的数据结构、算法。
73+
- [linux-tutorial](https://github.com/dunwu/linux-tutorial) - 是对 Linux 操作系统的经验总结。内容包含：Linux 常用命令；各种常见软件的 Linux 环境安装配置；运维、部署脚本；Shell、Python 语法教程；Git、Docker 教程。
74+
- [frontend-tutorial](https://github.com/dunwu/frontend-tutorial) - 前端教程
6975

7076
---
7177

‎docs/README.md‎

Lines changed: 28 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -9,37 +9,43 @@
99

1010
> 各种主流 Java 库的应用。
1111
12-
- [Dozer 使用指南](javalib/dozer.md)
13-
- [Freemark 使用指南](javalib/freemark.md)
12+
- [Dozer 应用指南](javalib/dozer.md)
13+
- [Freemark 应用指南](javalib/freemark.md)
1414
- [Java 与 JSON](javalib/javalib-json.md)
15-
- [细说 Java 主流日志工具库](javalib/java-log.md)
16-
- [细说 Java 主流工具包](javalib/java-util.md)
17-
- [JavaMail 使用指南](javalib/javamail.md)
18-
- [Jsoup 使用指南](javalib/jsoup.md)
19-
- [JUnit5 使用指南](javalib/junit.md)
20-
- [Lombok 使用指南](javalib/lombok.md)
21-
- [Mockito 使用指南](javalib/mockito.md)
22-
- [Reflections 使用指南](javalib/reflections.md)
23-
- [Thumbnailator 使用指南](javalib/thumbnailator.md)
24-
- [ZXing 使用指南](javalib/zxing.md)
15+
- [细说 Java 主流日志工具库](javalib/javalib-log.md)
16+
- [细说 Java 主流工具包](javalib/javalib-util.md)
17+
- [JavaMail 应用指南](javalib/javamail.md)
18+
- [Jsoup 应用指南](javalib/jsoup.md)
19+
- [JUnit5 应用指南](javalib/junit.md)
20+
- [Lombok 应用指南](javalib/lombok.md)
21+
- [Mockito 应用指南](javalib/mockito.md)
22+
- [Reflections 应用指南](javalib/reflections.md)
23+
- [Thumbnailator 应用指南](javalib/thumbnailator.md)
24+
- [ZXing 应用指南](javalib/zxing.md)
2525

2626
## [JavaTool](javatool/README.md)
2727

2828
> 各种主流 Java 工具的应用。
2929
3030
- [构建工具](javatool/build/README.md)
31-
- Maven 教程
31+
- [Maven 教程 📚](javatool/build/maven/README.md)
3232
- [Maven 快速指南](javatool/build/maven/maven-quickstart.md)
3333
- [Maven 教程之 pom.xml 详解](javatool/build/maven/maven-pom.md)
3434
- [Maven 教程之 settings.xml 详解](javatool/build/maven/maven-settings.md)
3535
- [Maven 实战问题和最佳实践](javatool/build/maven/maven-action.md)
3636
- [Maven 教程之发布 jar 到私服或中央仓库](javatool/build/maven/maven-deploy.md)
37-
- [Maven 插件之代码检查](javatool/build/maven/plugins/maven-checkstyle.md)
37+
- [Maven 插件之代码检查](javatool/build/maven/maven-checkstyle-plugin.md)
3838
- [Ant 简易教程](javatool/build/ant.md)
39-
- Java IDE
40-
- [Intellij IDEA 使用指南](javatool/ide/intellij.md)
41-
- [Eclipse 使用指南](javatool/ide/eclipse.md)
42-
- **测试**
39+
- [搜索引擎 Elastic](javatool/elastic/README.md)
40+
- [Elastic 技术栈快速入门](javatool/elastic/elastic-quickstart.md)
41+
- [Elasticsearch 运维](javatool/elastic/elastic-elasticsearch-ops.md)
42+
- [Beats 运维](javatool/elastic/elastic-beats-ops.md)
43+
- [Kibana 运维](javatool/elastic/elastic-kibana-ops.md)
44+
- [Logstash 运维](javatool/elastic/elastic-logstash-ops.md)
45+
- [Java IDE](javatool/ide/README.md)
46+
- [Intellij IDEA 应用指南](javatool/ide/intellij.md)
47+
- [Eclipse 应用指南](javatool/ide/eclipse.md)
48+
- **测试工具**
4349
- [Jmeter 应用指南](javatool/test/jmeter.md)
4450

4551
## [JavaCore 教程](https://dunwu.github.io/javacore/)
@@ -62,10 +68,10 @@
6268

6369
## 相关技术栈
6470

65-
- :1234: [db-tutorial](https://dunwu.github.io/db-tutorial/) - 是对数据库领域开发经验的总结。内容包含：关系型数据库和 Nosql 理论、Mysql、Redis 等。
66-
- :dart: [algorithm-tutorial](https://dunwu.github.io/algorithm-tutorial/) - 是对数据结构和算法的总结。内容包含：一些基本的数据结构、算法。
67-
- :penguin: [linux-tutorial](https://github.com/dunwu/linux-tutorial) - 是对 Linux 操作系统的经验总结。内容包含：Linux 常用命令；各种常见软件的 Linux 环境安装配置；运维、部署脚本；Shell、Python 语法教程；Git、Docker 教程。
68-
- :art: [frontend-tutorial](https://github.com/dunwu/frontend-tutorial) - 前端教程
71+
- [db-tutorial](https://dunwu.github.io/db-tutorial/) - 是对数据库领域开发经验的总结。内容包含：关系型数据库和 Nosql 理论、Mysql、Redis 等。
72+
- [algorithm-tutorial](https://dunwu.github.io/algorithm-tutorial/) - 是对数据结构和算法的总结。内容包含：一些基本的数据结构、算法。
73+
- [linux-tutorial](https://github.com/dunwu/linux-tutorial) - 是对 Linux 操作系统的经验总结。内容包含：Linux 常用命令；各种常见软件的 Linux 环境安装配置；运维、部署脚本；Shell、Python 语法教程；Git、Docker 教程。
74+
- [frontend-tutorial](https://github.com/dunwu/frontend-tutorial) - 前端教程
6975

7076
---
7177

‎docs/book.json‎

Lines changed: 69 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,69 @@
1+
{
2+
"gitbook": "3.2.2",
3+
"title": "java-tutorial",
4+
"language": "zh-hans",
5+
"root": "./",
6+
"structure": {
7+
"summary": "sidebar.md"
8+
},
9+
"links": {
10+
"sidebar": {
11+
"java-tutorial": "https://github.com/dunwu/java-tutorial"
12+
}
13+
},
14+
"plugins": [
15+
"-lunr",
16+
"-search",
17+
"advanced-emoji@^0.2.2",
18+
"anchor-navigation-ex@1.0.10",
19+
"anchors@^0.7.1",
20+
"edit-link@^2.0.2",
21+
"expandable-chapters-small@^0.1.7",
22+
"github@^2.0.0",
23+
"search-plus@^0.0.11",
24+
"simple-page-toc@^0.1.1",
25+
"splitter@^0.0.8",
26+
"tbfed-pagefooter@^0.0.1"
27+
],
28+
"pluginsConfig": {
29+
"anchor-navigation-ex": {
30+
"showLevel": false,
31+
"associatedWithSummary": true,
32+
"multipleH1": true,
33+
"mode": "float",
34+
"isRewritePageTitle": false,
35+
"float": {
36+
"showLevelIcon": false,
37+
"level1Icon": "fa fa-hand-o-right",
38+
"level2Icon": "fa fa-hand-o-right",
39+
"level3Icon": "fa fa-hand-o-right"
40+
},
41+
"pageTop": {
42+
"showLevelIcon": false,
43+
"level1Icon": "fa fa-hand-o-right",
44+
"level2Icon": "fa fa-hand-o-right",
45+
"level3Icon": "fa fa-hand-o-right"
46+
}
47+
},
48+
"edit-link": {
49+
"base": "https://github.com/dunwu/java-tutorial/blob/master/docs",
50+
"label": "编辑此页面"
51+
},
52+
"github": {
53+
"url": "https://github.com/dunwu"
54+
},
55+
"simple-page-toc": {
56+
"maxDepth": 4,
57+
"skipFirstH1": true
58+
},
59+
"sharing": {
60+
"weibo": true,
61+
"all": ["weibo"]
62+
},
63+
"tbfed-pagefooter": {
64+
"copyright": "Copyright © Zhang Peng 2017",
65+
"modify_label": "该文件上次修订时间：",
66+
"modify_format": "YYYY-MM-DD HH:mm:ss"
67+
}
68+
}
69+
}

‎docs/cover.jpg‎

115 KB
Loading

‎docs/index.html‎

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -169,7 +169,6 @@
169169
}
170170

171171
.markdown-section p {
172-
line-height: 1rem;
173172
word-spacing: 0.05rem;
174173
}
175174
</style>

‎docs/javalib/dozer.md‎

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# Dozer 使用指南
1+
# Dozer 应用指南
22

33
这篇文章是本人在阅读 Dozer 官方文档（5.5.1 版本，官网已经一年多没更新了）的过程中，整理下来我认为比较基础的应用场景。
44

@@ -8,17 +8,17 @@
88

99
- [简介](#简介)
1010
- [安装](#安装)
11-
- [引入 jar 包](#引入-jar-包)
12-
- [Eclipse 插件](#eclipse-插件)
11+
- [引入 jar 包](#引入-jar-包)
12+
- [Eclipse 插件](#eclipse-插件)
1313
- [使用](#使用)
14-
- [准备](#准备)
15-
- [Dozer 的配置](#dozer-的配置)
16-
- [与 Spring 整合](#与-spring-整合)
14+
- [准备](#准备)
15+
- [Dozer 的配置](#dozer-的配置)
16+
- [与 Spring 整合](#与-spring-整合)
1717
- [Dozer 支持的数据类型转换](#dozer-支持的数据类型转换)
1818
- [Dozer 的映射配置](#dozer-的映射配置)
19-
- [用注解来配置映射](#用注解来配置映射)
20-
- [用 API 来配置映射](#用-api-来配置映射)
21-
- [用 XML 来配置映射](#用-xml-来配置映射)
19+
- [用注解来配置映射](#用注解来配置映射)
20+
- [用 API 来配置映射](#用-api-来配置映射)
21+
- [用 XML 来配置映射](#用-xml-来配置映射)
2222
- [参考](#参考)
2323

2424
<!-- /TOC -->

‎docs/javalib/freemark.md‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
1-
# Freemark 使用指南
1+
# Freemark 应用指南
22

33
> FreeMarker 是一款 模板引擎： 即一种基于模板和要改变的数据， 并用来生成输出文本(HTML 网页，电子邮件，配置文件，源代码等)的通用工具。 它不是面向最终用户的，而是一个 Java 类库，是一款程序员可以嵌入他们所开发产品的组件。
44
55
<!-- TOC depthFrom:2 depthTo:3 -->
66

77
- [简介](#简介)
8-
- [什么是 Freemark？](#什么是-freemark)
8+
- [什么是 Freemark？](#什么是-freemark)
99
- [入门](#入门)
10-
- [创建 Configuration 实例](#创建-configuration-实例)
11-
- [创建数据模型](#创建数据模型)
12-
- [获取模板](#获取模板)
13-
- [合并模板和数据模型](#合并模板和数据模型)
14-
- [完整示例](#完整示例)
10+
- [创建 Configuration 实例](#创建-configuration-实例)
11+
- [创建数据模型](#创建数据模型)
12+
- [获取模板](#获取模板)
13+
- [合并模板和数据模型](#合并模板和数据模型)
14+
- [完整示例](#完整示例)
1515
- [基础](#基础)
16-
- [数值](#数值)
17-
- [类型](#类型)
18-
- [模板](#模板)
16+
- [数值](#数值)
17+
- [类型](#类型)
18+
- [模板](#模板)
1919
- [参考资料](#参考资料)
2020

2121
<!-- /TOC -->

‎docs/javalib/javalib-binary.md‎

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,14 +6,14 @@
66

77
原因很简单，就是 Java 默认的序列化机制（`ObjectInputStream` 和 `ObjectOutputStream`）具有很多缺点。
88

9-
> 不了解 Java 默认的序列化机制，可以参考：[Java 序列化](https://github.com/dunwu/javacore/blob/master/docs/io/Java序列化.md)
9+
> 不了解 Java 默认的序列化机制，可以参考：[Java 序列化](https://github.com/dunwu/javacore/blob/master/docs/io/Java序列化.md)
1010
1111
Java 自身的序列化方式具有以下缺点：
1212

1313
- **无法跨语言使用 **。这点最为致命，对于很多需要跨语言通信的异构系统来说，不能跨语言序列化，即意味着完全无法通信（彼此数据不能识别，当然无法交互了）。
14-
- **序列化的性能不高**。序列化后的数据体积较大，这大大影响存储和传输的效率。
15-
- 序列化一定需要实现 `Serializable` 接口。
16-
- 需要关注 `serialVersionUID`。
14+
- **序列化的性能不高**。序列化后的数据体积较大，这大大影响存储和传输的效率。
15+
- 序列化一定需要实现 `Serializable` 接口。
16+
- 需要关注 `serialVersionUID`。
1717

1818
引入二进制序列化库就是为了解决这些问题，这在 RPC 应用中尤为常见。
1919

@@ -86,6 +86,7 @@ Java 自身的序列化方式具有以下缺点：
8686
**（2）选型建议**
8787

8888
- 如果需要跨语言通信，那么可以考虑：Protobuf、Thrift、Hession。
89+
8990
- [thrift](https://github.com/apache/thrift)、[protobuf](https://github.com/protocolbuffers/protobuf) - 适用于对性能敏感，对开发体验要求不高的内部系统。
9091
- [hessian](http://hessian.caucho.com/doc/hessian-overview.xtp) - 适用于对开发体验敏感，性能有要求的内外部系统。
9192

@@ -334,4 +335,4 @@ System.out.printf("Kryo 序列化/反序列化耗时：%s", (end - begin));
334335
- [Hessian 官网](http://hessian.caucho.com/)
335336
- [FST Github](https://github.com/RuedigerMoeller/fast-serialization)
336337
- **文章**
337-
- [java序列化框架对比](https://www.jianshu.com/p/937883b6b2e5)
338+
- [java 序列化框架对比](https://www.jianshu.com/p/937883b6b2e5)

docs/javalib/java-log.md renamed to docs/javalib/javalib-log.md

Lines changed: 17 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -11,28 +11,28 @@
1111
<!-- TOC depthFrom:2 depthTo:3 -->
1212

1313
- [日志框架](#日志框架)
14-
- [java.util.logging (JUL)](#javautillogging-jul)
15-
- [Log4j](#log4j)
16-
- [Logback](#logback)
17-
- [Log4j2](#log4j2)
18-
- [Log4j vs Logback vs Log4j2](#log4j-vs-logback-vs-log4j2)
14+
- [java.util.logging (JUL)](#javautillogging-jul)
15+
- [Log4j](#log4j)
16+
- [Logback](#logback)
17+
- [Log4j2](#log4j2)
18+
- [Log4j vs Logback vs Log4j2](#log4j-vs-logback-vs-log4j2)
1919
- [日志门面](#日志门面)
20-
- [common-logging](#common-logging)
21-
- [slf4j](#slf4j)
22-
- [common-logging vs slf4j](#common-logging-vs-slf4j)
23-
- [总结](#总结)
20+
- [common-logging](#common-logging)
21+
- [slf4j](#slf4j)
22+
- [common-logging vs slf4j](#common-logging-vs-slf4j)
23+
- [总结](#总结)
2424
- [实施日志解决方案](#实施日志解决方案)
25-
- [引入 jar 包](#引入-jar-包)
26-
- [使用 API](#使用-api)
25+
- [引入 jar 包](#引入-jar-包)
26+
- [使用 API](#使用-api)
2727
- [log4j2 配置](#log4j2-配置)
2828
- [logback 配置](#logback-配置)
29-
- [`<configuration>`](#configuration)
30-
- [`<appender>`](#appender)
31-
- [`<logger>`](#logger)
32-
- [`<root>`](#root)
33-
- [完整的 logback.xml 参考示例](#完整的-logbackxml-参考示例)
29+
- [`<configuration>`](#configuration)
30+
- [`<appender>`](#appender)
31+
- [`<logger>`](#logger)
32+
- [`<root>`](#root)
33+
- [完整的 logback.xml 参考示例](#完整的-logbackxml-参考示例)
3434
- [log4j 配置](#log4j-配置)
35-
- [完整的 log4j.xml 参考示例](#完整的-log4jxml-参考示例)
35+
- [完整的 log4j.xml 参考示例](#完整的-log4jxml-参考示例)
3636
- [参考](#参考)
3737

3838
<!-- /TOC -->

0 commit comments

Comments
 (0)