Skip to content

Commit e57ae00

Browse files
dunwudunwu
committed
update docs
1 parent 362f6f2 commit e57ae00

7 files changed

Lines changed: 594 additions & 190 deletions

File tree

‎README.md‎

Lines changed: 11 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,25 +5,13 @@
55
> - 🔁 项目同步维护：[Github](https://github.com/dunwu/java-tutorial/) | [Gitee](https://gitee.com/turnon/java-tutorial/)
66
> - 📖 电子书阅读：[Github Pages](https://dunwu.github.io/java-tutorial/) | [Gitee Pages](https://turnon.gitee.io/java-tutorial/)
77
8-
## [JavaCore 教程](https://dunwu.github.io/javacore/)
9-
10-
> Java 核心技术教程。内容包含：Java 基础特性、Java 高级特性、Java 并发、JVM、Java IO 等。
11-
>
12-
> 已独立维护在另一个项目中。
13-
14-
## [JavaWeb 教程](https://dunwu.github.io/javaweb/)
15-
16-
> Java Web 技术教程。内容包含：JavaEE、分布式应用技术等。
17-
>
18-
> 已独立维护在另一个项目中。
19-
208
## [JavaLib](docs/javalib/README.md)
219

2210
> 各种主流 Java 库的应用。
2311
2412
- [Dozer 使用指南](docs/javalib/dozer.md)
2513
- [Freemark 使用指南](docs/javalib/freemark.md)
26-
- [细说 Java 主流 JSON 库](docs/javalib/java-json.md)
14+
- [细说 Java 主流 JSON 库](docs/javalib/javalib-json.md)
2715
- [细说 Java 主流日志工具库](docs/javalib/java-log.md)
2816
- [细说 Java 主流工具包](docs/javalib/java-util.md)
2917
- [JavaMail 使用指南](docs/javalib/javamail.md)
@@ -49,17 +37,24 @@
4937
- [Maven 插件之代码检查](docs/javatool/build/maven/plugins/maven-checkstyle.md)
5038
- [Ant 简易教程](docs/javatool/build/ant.md)
5139
- Java IDE
52-
5340
- [Intellij IDEA 使用指南](docs/javatool/ide/intellij.md)
5441
- [Eclipse 使用指南](docs/javatool/ide/eclipse.md)
5542

43+
## [JavaCore 教程](https://dunwu.github.io/javacore/)
44+
45+
> Java 核心技术教程。内容包含：Java 基础特性、Java 高级特性、Java 并发、JVM、Java IO 等。
46+
47+
## [JavaWeb 教程](https://dunwu.github.io/javaweb/)
48+
49+
> Java Web 技术教程。内容包含：JavaEE、分布式应用技术等。
50+
5651
## [Spring 教程](https://dunwu.github.io/spring-tutorial/)
5752

58-
> 已独立维护在另一个项目中。
53+
> Spring 教程。
5954
6055
## [Spring Boot 教程](https://dunwu.github.io/spring-boot-tutorial/)
6156

62-
> 已独立维护在另一个项目中。
57+
> Spring Boot 教程
6358
6459
---
6560

‎docs/README.md‎

Lines changed: 11 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -5,25 +5,13 @@
55
> - 🔁 项目同步维护：[Github](https://github.com/dunwu/java-tutorial/) | [Gitee](https://gitee.com/turnon/java-tutorial/)
66
> - 📖 电子书阅读：[Github Pages](https://dunwu.github.io/java-tutorial/) | [Gitee Pages](https://turnon.gitee.io/java-tutorial/)
77
8-
## [JavaCore 教程](https://dunwu.github.io/javacore/)
9-
10-
> Java 核心技术教程。内容包含：Java 基础特性、Java 高级特性、Java 并发、JVM、Java IO 等。
11-
>
12-
> 已独立维护在另一个项目中。
13-
14-
## [JavaWeb 教程](https://dunwu.github.io/javaweb/)
15-
16-
> Java Web 技术教程。内容包含：JavaEE、分布式应用技术等。
17-
>
18-
> 已独立维护在另一个项目中。
19-
208
## [JavaLib](javalib/README.md)
219

2210
> 各种主流 Java 库的应用。
2311
2412
- [Dozer 使用指南](javalib/dozer.md)
2513
- [Freemark 使用指南](javalib/freemark.md)
26-
- [细说 Java 主流 JSON 库](javalib/java-json.md)
14+
- [细说 Java 主流 JSON 库](javalib/javalib-json.md)
2715
- [细说 Java 主流日志工具库](javalib/java-log.md)
2816
- [细说 Java 主流工具包](javalib/java-util.md)
2917
- [JavaMail 使用指南](javalib/javamail.md)
@@ -49,17 +37,24 @@
4937
- [Maven 插件之代码检查](javatool/build/maven/plugins/maven-checkstyle.md)
5038
- [Ant 简易教程](javatool/build/ant.md)
5139
- Java IDE
52-
5340
- [Intellij IDEA 使用指南](javatool/ide/intellij.md)
5441
- [Eclipse 使用指南](javatool/ide/eclipse.md)
5542

43+
## [JavaCore 教程](https://dunwu.github.io/javacore/)
44+
45+
> Java 核心技术教程。内容包含：Java 基础特性、Java 高级特性、Java 并发、JVM、Java IO 等。
46+
47+
## [JavaWeb 教程](https://dunwu.github.io/javaweb/)
48+
49+
> Java Web 技术教程。内容包含：JavaEE、分布式应用技术等。
50+
5651
## [Spring 教程](https://dunwu.github.io/spring-tutorial/)
5752

58-
> 已独立维护在另一个项目中。
53+
> Spring 教程。
5954
6055
## [Spring Boot 教程](https://dunwu.github.io/spring-boot-tutorial/)
6156

62-
> 已独立维护在另一个项目中。
57+
> Spring Boot 教程
6358
6459
---
6560

‎docs/index.html‎

Lines changed: 41 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -4,14 +4,13 @@
44
<meta charset="UTF-8" />
55
<title>Java Tutorial</title>
66
<meta content="IE=edge,chrome=1" http-equiv="X-UA-Compatible" />
7-
<meta content="java-tutorial" name="description" />
7+
<meta content="Java Tutorial" name="description" />
88
<meta
99
content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0"
1010
name="viewport"
1111
/>
1212
<link href="http://dunwu.test.upcdn.net/common/logo/zp_50_50.png" rel="icon" type="image/x-icon" />
1313
<link href="//unpkg.com/docsify/lib/themes/vue.css" rel="stylesheet" title="vue" />
14-
<link href="//unpkg.com/gitalk/dist/gitalk.css" rel="stylesheet" />
1514
<style>
1615
h1 + ul {
1716
display: block !important;
@@ -70,18 +69,37 @@
7069
}
7170

7271
/* content 样式内容 */
72+
.content a,
7373
.sidebar a,
74-
.content a {
74+
.sidebar ul li a,
75+
.sidebar ul li a strong {
7576
color: #399ab2 !important;
7677
text-decoration: none !important;
7778
}
7879

80+
.content a:hover,
7981
.sidebar a:hover,
80-
.content a:hover {
82+
.sidebar ul li a:hover,
83+
.sidebar ul li a strong:hover {
8184
color: #fe4165 !important;
8285
text-decoration: underline !important;
8386
}
8487

88+
.sidebar h2 span {
89+
font-size: 18px;
90+
color: #399ab2 !important;
91+
text-decoration: none !important;
92+
}
93+
94+
.sidebar h2 span:hover {
95+
color: #fe4165 !important;
96+
text-decoration: underline !important;
97+
}
98+
99+
.sidebar .sidebar-nav {
100+
padding-left: 20px;
101+
}
102+
85103
.content h1 :hover,
86104
.content h2 :hover,
87105
.content h3 :hover,
@@ -105,6 +123,7 @@
105123
}
106124
}
107125

126+
.markdown-section h1,
108127
.content h1 a,
109128
.content h1 span {
110129
color: #399ab2 !important;
@@ -227,46 +246,40 @@
227246
</head>
228247
<body>
229248
<div id="app">正在加载...</div>
249+
<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
250+
<script src="//unpkg.com/docsify-edit-on-github/index.js"></script>
230251
<script>
231252
window.$docsify = {
232253
name: 'java-tutorial',
233254
repo: 'https://github.com/dunwu/java-tutorial',
234255
logo: 'http://dunwu.test.upcdn.net/common/logo/zp_100_100.png',
235256
auto2top: true,
236257
coverpage: 'coverpage.md',
258+
loadSidebar: 'sidebar.md',
237259
maxLevel: 4,
238-
subMaxLevel: 4,
260+
subMaxLevel: 2,
239261
formatUpdated: '{MM}/{DD} {HH}:{mm}',
240262
search: {
241263
maxAge: 86400000,
242264
paths: ['/'],
243265
placeholder: '🔍 搜索',
244-
noData: '没有结果！',
266+
noData: '😭 没有结果！',
245267
depth: 4
246-
}
268+
},
269+
disqus: 'java-tutorial',
270+
plugins: [
271+
EditOnGithubPlugin.create('https://github.com/dunwu/java-tutorial/tree/master/docs/', null, function(file) {
272+
if (file.indexOf('en') === -1) {
273+
return '📝 编辑文档'
274+
} else {
275+
return '📝 Edit Document'
276+
}
277+
})
278+
]
247279
}
248280
</script>
249-
250-
<script src="//unpkg.com/docsify/lib/docsify.min.js"></script>
251-
<script src="//unpkg.com/docsify/lib/plugins/emoji.js"></script>
252-
<script src="//unpkg.com/docsify/lib/plugins/zoom-image.js"></script>
253-
<script src="//unpkg.com/docsify/lib/plugins/search.js"></script>
254-
<script src="//unpkg.com/docsify/lib/plugins/gitalk.min.js"></script>
255-
<script src="//unpkg.com/gitalk/dist/gitalk.min.js"></script>
256-
<script>
257-
const gitalk = new Gitalk({
258-
clientID: '1ba9606d18aec7c070d4',
259-
clientSecret: 'f45be2f8a0706191d5082f92a5a4687066cdd18c',
260-
repo: 'java-tutorial',
261-
owner: 'dunwu',
262-
admin: ['dunwu'],
263-
number: 1,
264-
distractionFreeMode: true,
265-
labels: ['talk'],
266-
title: 'Welcome to java-tutorial',
267-
perPage: 15,
268-
})
269-
</script>
281+
<script src="//unpkg.com/docsify/lib/plugins/disqus.min.js"></script>
282+
<script src="//unpkg.com/docsify/lib/plugins/search.min.js"></script>
270283

271284
<!--代码高亮-->
272285
<!--@see https://github.com/PrismJS/prism -->

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

Lines changed: 34 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -2,21 +2,25 @@
22

33
<!-- TOC depthFrom:2 depthTo:3 -->
44

5-
- [JSON 简介](#json-简介)
6-
- [Java JSON 库](#java-json-库)
7-
- [Fastjson](#fastjson)
8-
- [添加 maven 依赖](#添加-maven-依赖)
9-
- [Fastjson API](#fastjson-api)
10-
- [Fastjson 注解](#fastjson-注解)
11-
- [Jackson](#jackson)
12-
- [添加 maven 依赖](#添加-maven-依赖-1)
13-
- [Jackson API](#jackson-api)
14-
- [Jackson 注解](#jackson-注解)
15-
- [参考资料](#参考资料)
5+
- [1. JSON 简介](#1-json-简介)
6+
- [1.1. JSON 数据结构](#11-json-数据结构)
7+
- [1.2. Java JSON 库](#12-java-json-库)
8+
- [2. Fastjson](#2-fastjson)
9+
- [2.1. 添加 maven 依赖](#21-添加-maven-依赖)
10+
- [2.2. Fastjson API](#22-fastjson-api)
11+
- [2.3. Fastjson 注解](#23-fastjson-注解)
12+
- [3. Jackson](#3-jackson)
13+
- [3.1. 添加 maven 依赖](#31-添加-maven-依赖)
14+
- [3.2. Jackson API](#32-jackson-api)
15+
- [3.3. Jackson 注解](#33-jackson-注解)
16+
- [4. 示例源码](#4-示例源码)
17+
- [5. 参考资料](#5-参考资料)
1618

1719
<!-- /TOC -->
1820

19-
## JSON 简介
21+
## 1. JSON 简介
22+
23+
### 1.1. JSON 数据结构
2024

2125
JSON（JavaScript Object Notation）是一种基于文本的数据交换格式。几乎所有的编程语言都有很好的库或第三方工具来提供基于 JSON 的 API 支持，因此你可以非常方便地使用任何自己喜欢的编程语言来处理 JSON 数据。
2226

@@ -31,19 +35,19 @@ JSON 建构于两种结构：
3135
>
3236
> - [json 的 RFC 文档](http://tools.ietf.org/html/rfc4627)
3337
34-
## Java JSON 库
38+
### 1.2. Java JSON 库
3539

3640
Java 中比较流行的 JSON 库有：
3741

3842
- [Fastjson](https://github.com/alibaba/fastjson)
3943
- [Jackson](http://wiki.fasterxml.com/JacksonHome)
4044
- [Gson](https://github.com/google/gson)
4145

42-
## Fastjson
46+
## 2. Fastjson
4347

4448
[fastjson](https://github.com/alibaba/fastjson) 是阿里巴巴的开源 JSON 解析库。
4549

46-
### 添加 maven 依赖
50+
### 2.1. 添加 maven 依赖
4751

4852
```xml
4953
<dependency>
@@ -53,7 +57,7 @@ Java 中比较流行的 JSON 库有：
5357
</dependency>
5458
```
5559

56-
### Fastjson API
60+
### 2.2. Fastjson API
5761

5862
#### JavaBean 的序列化和反序列化
5963

@@ -62,7 +66,7 @@ String text = JSON.toJSONString(obj); //序列化
6266
VO vo = JSON.parseObject("{...}", VO.class); //反序列化
6367
```
6468

65-
### Fastjson 注解
69+
### 2.3. Fastjson 注解
6670

6771
#### `@JSONField`
6872

@@ -110,11 +114,11 @@ public static class B {
110114
}
111115
```
112116

113-
## Jackson
117+
## 3. Jackson
114118

115119
以下仅列举个人认为比较常用的特性。
116120

117-
### 添加 maven 依赖
121+
### 3.1. 添加 maven 依赖
118122

119123
```xml
120124
<dependency>
@@ -124,7 +128,7 @@ public static class B {
124128
</dependency>
125129
```
126130

127-
### Jackson API
131+
### 3.2. Jackson API
128132

129133
> 扩展阅读：更多 API 使用细节可以参考 [jackson-databind 官方说明](https://github.com/FasterXML/jackson-databind)
130134
@@ -154,7 +158,9 @@ String jsonString = mapper.writeValueAsString(myResultObject);
154158

155159
#### 容器的序列化和反序列化
156160

157-
```> 扩展阅读：更多 API 使用细节可以参考 [jackson-databind 官方说明](https://github.com/FasterXML/jackson-databind)java
161+
> 扩展阅读：更多 API 使用细节可以参考 [jackson-databind 官方说明](https://github.com/FasterXML/jackson-databind)
162+
163+
```java
158164
Person p = new Person("Tom", 20);
159165
Person p2 = new Person("Jack", 22);
160166
Person p3 = new Person("Mary", 18);
@@ -175,7 +181,7 @@ try {
175181
}
176182
```
177183

178-
### Jackson 注解
184+
### 3.3. Jackson 注解
179185

180186
> 扩展阅读：更多注解使用细节可以参考 [jackson-annotations 官方说明](https://github.com/FasterXML/jackson-annotations/wiki/Jackson-Annotations)
181187
@@ -238,12 +244,16 @@ public class CtorBean {
238244

239245
alphabetic 设为 true 表示，json 字段按自然顺序排列，默认为 false。
240246

241-
```
247+
```java
242248
@JsonPropertyOrder(alphabetic = true)
243249
public class JacksonAnnotationBean {}
244250
```
245251

246-
## 参考资料
252+
## 4. 示例源码
253+
254+
> 示例源码：[javalib-io-json](https://github.com/dunwu/java-tutorial/tree/master/javalib-io-json)
255+
256+
## 5. 参考资料
247257

248258
- http://www.json.org/json-zh.html
249259
- [json 的 RFC 文档](http://tools.ietf.org/html/rfc4627)

0 commit comments

Comments
 (0)