Skip to content

Commit bc0aa04

Browse files
dunwudunwu
committed
📝 Writing docs.
1 parent 77621c5 commit bc0aa04

6 files changed

Lines changed: 131 additions & 86 deletions

File tree

‎README.md‎

Lines changed: 15 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -18,24 +18,24 @@
1818

1919
### [JavaEE](https://github.com/dunwu/javaee-notes)
2020

21-
### Java 框架
21+
### [Java 框架](docs/framework/README.md)
2222

2323
* [Spring](https://github.com/dunwu/spring-notes)
24+
* [Dubbo](docs/framework/dubbo/README.md)
2425

25-
### Java 库
26+
### [Java 库](docs/javalib/README.md)
2627

27-
* [Java 库](docs/javalib/README.md)
28-
* [ActiveMQ 使用小结](docs/javalib/activemq.md)
29-
* [Dozer 使用小结](docs/javalib/dozer.md)
30-
* [细说 Java 主流日志工具库](docs/javalib/java-log.md)
31-
* [JavaMail 使用小结](docs/javalib/javamail.md)
32-
* [jsoup 使用小结](docs/javalib/jsoup.md)
33-
* [JUnit 使用小结](docs/javalib/junit.md)
34-
* [Lombok 使用小结](docs/javalib/lombok.md)
35-
* [Thumbnailator 使用小结](docs/javalib/thumbnailator.md)
36-
* [ZXing 使用小结](docs/javalib/zxing.md)
28+
* [ActiveMQ 使用小结](docs/javalib/activemq.md)
29+
* [Dozer 使用小结](docs/javalib/dozer.md)
30+
* [细说 Java 主流日志工具库](docs/javalib/java-log.md)
31+
* [JavaMail 使用小结](docs/javalib/javamail.md)
32+
* [jsoup 使用小结](docs/javalib/jsoup.md)
33+
* [JUnit 使用小结](docs/javalib/junit.md)
34+
* [Lombok 使用小结](docs/javalib/lombok.md)
35+
* [Thumbnailator 使用小结](docs/javalib/thumbnailator.md)
36+
* [ZXing 使用小结](docs/javalib/zxing.md)
3737

38-
### Java 工具
38+
### [Java 工具](docs/javatool/README.md)
3939

4040
* [构建工具](docs/javatool/build/README.md)
4141
* [Maven 快速指南（一）](docs/javatool/build/maven/maven-quickstart-01.md)
@@ -56,11 +56,11 @@
5656
* [Java 服务器](docs/javatool/server/README.md)
5757
* [Jetty 使用小结](docs/javatool/server/jetty.md)
5858

59-
### 技术扩展
59+
### [技术扩展](docs/extend/README.md)
6060

6161
* [数据库](docs/extend/database.md)
6262
* [数据结构和算法](docs/extend/algorithm.md)
63-
* [Linux](docs/extend/linux.md)
63+
* [Linux](docs/extend/os.md)
6464
* [网络](docs/extend/web/README.md)
6565
* [nginx 快速入门](docs/extend/web/nginx-quickstart.md)
6666

‎docs/extend/README.md‎

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,11 @@
11
# 技术扩展
2+
3+
> 这部分内容主要是 Java 技术栈的延伸领域。例如：数据库、数据结构和算法、网络协议、操作系统等。
4+
5+
## 目录
6+
7+
* [数据库](database.md)
8+
* [数据结构和算法](algorithm.md)
9+
* [Linux](os.md)
10+
* [网络](web/README.md)
11+
* [nginx 快速入门](web/nginx-quickstart.md)

‎docs/framework/README.md‎

Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
# Java 框架
2+
3+
> 这部分内容主要是 Java 技术领域的一些流行框架。如 rpc 框架（dubbo）、安全框架（shiro）、mvc 框架（spring）、orm 框架（hibernate、mybatis）
4+
> 这部分内容还在整理。
5+
6+
## 目录

‎docs/framework/spring.md‎

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
# Spring
2+
3+
> Spring 是一个开源的 Java/Java EE 全功能栈（full-stack）的应用程序框架。
4+
>
5+
> Spring 知识结构非常庞大。全部整理归纳在 [**spring-notes**](https://github.com/dunwu/spring-notes) 项目中。

‎docs/javatool/README.md‎

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
# Java 工具
2+
3+
> 本部分内容主要是 Java 开发领域使用的一些 Java 工具，如构建工具、IDE、服务器、日志中心等等。
4+
5+
## 目录
6+
7+
* [构建工具](build/README.md)
8+
* [Maven 快速指南（一）](build/maven/maven-quickstart-01.md)
9+
* [Maven 快速指南（二）](build/maven/maven-quickstart-02.md)
10+
* [Maven 之 pom.xml 详解（一）](build/maven/maven-pom-01.md)
11+
* [Maven 之 pom.xml 详解（二）](build/maven/maven-pom-02.md)
12+
* [Maven 之 pom.xml 详解（三）](build/maven/maven-pom-03.md)
13+
* [Maven 之 settings.xml 详解](build/maven/maven-settings-config.md)
14+
* [发布项目到中央仓库](build/maven/maven-deploy.md)
15+
* [Maven 排错](build/maven/maven-faq.md)
16+
* [Ant 简易教程](build/ant.md)
17+
* [Elastic](elastic/README.md)
18+
* [Elastic 技术栈之快速指南](elastic/elastic-quickstart.md)
19+
* [Elastic 技术栈之 Logstash 基础](elastic/elastic-logstash.md)
20+
* [Java IDE](ide/README.md)
21+
* [Intellij IDEA 使用小结](ide/intellij.md)
22+
* [Eclipse 使用小结](ide/eclipse.md)
23+
* [Java 服务器](server/README.md)
24+
* [Jetty 使用小结](server/jetty.md)

‎docs/javatool/elastic/elastic-logstash.md‎

Lines changed: 71 additions & 71 deletions
Original file line numberDiff line numberDiff line change
@@ -323,19 +323,19 @@ bin/logstash -f logstash-input-stdin.conf
323323
324324
（1）创建 `logstash-input-tcp.conf` ：
325325
326-
```
327-
input {
328-
tcp {
329-
port => 9251
330-
codec => json_lines
331-
mode => server
332-
}
333-
}
334-
output {
335-
elasticsearch { hosts => ["localhost:9200"] }
336-
stdout { codec => rubydebug }
337-
}
338-
```
326+
```
327+
input {
328+
tcp {
329+
port => 9251
330+
codec => json_lines
331+
mode => server
332+
}
333+
}
334+
output {
335+
elasticsearch { hosts => ["localhost:9200"] }
336+
stdout { codec => rubydebug }
337+
}
338+
```
339339
340340
更多配置项可以参考：https://www.elastic.co/guide/en/logstash/current/plugins-inputs-tcp.html
341341
@@ -346,46 +346,46 @@ bin/logstash -f logstash-input-stdin.conf
346346
347347
（1）在 Java 应用的 pom.xml 中引入 jar 包：
348348
349-
```xml
350-
<dependency>
351-
<groupId>net.logstash.logback</groupId>
352-
<artifactId>logstash-logback-encoder</artifactId>
353-
<version>4.11</version>
354-
</dependency>
355-
356-
<!-- logback 依赖包 -->
357-
<dependency>
358-
<groupId>ch.qos.logback</groupId>
359-
<artifactId>logback-core</artifactId>
360-
<version>1.2.3</version>
361-
</dependency>
362-
<dependency>
363-
<groupId>ch.qos.logback</groupId>
364-
<artifactId>logback-classic</artifactId>
365-
<version>1.2.3</version>
366-
</dependency>
367-
<dependency>
368-
<groupId>ch.qos.logback</groupId>
369-
<artifactId>logback-access</artifactId>
370-
<version>1.2.3</version>
371-
</dependency>
372-
```
349+
```xml
350+
<dependency>
351+
<groupId>net.logstash.logback</groupId>
352+
<artifactId>logstash-logback-encoder</artifactId>
353+
<version>4.11</version>
354+
</dependency>
355+
356+
<!-- logback 依赖包 -->
357+
<dependency>
358+
<groupId>ch.qos.logback</groupId>
359+
<artifactId>logback-core</artifactId>
360+
<version>1.2.3</version>
361+
</dependency>
362+
<dependency>
363+
<groupId>ch.qos.logback</groupId>
364+
<artifactId>logback-classic</artifactId>
365+
<version>1.2.3</version>
366+
</dependency>
367+
<dependency>
368+
<groupId>ch.qos.logback</groupId>
369+
<artifactId>logback-access</artifactId>
370+
<version>1.2.3</version>
371+
</dependency>
372+
```
373373

374374
（2）接着，在 logback.xml 中添加 appender
375375

376-
```xml
377-
<appender name="ELK-TCP" class="net.logstash.logback.appender.LogstashTcpSocketAppender">
378-
<!--
379-
destination 是 logstash 服务的 host:port，
380-
相当于和 logstash 建立了管道，将日志数据定向传输到 logstash
381-
-->
382-
<destination>192.168.28.32:9251</destination>
383-
<encoder charset="UTF-8" class="net.logstash.logback.encoder.LogstashEncoder"/>
384-
</appender>
385-
<logger name="io.github.dunwu.spring" level="TRACE" additivity="false">
386-
<appender-ref ref="ELK-TCP" />
387-
</logger>
388-
```
376+
```xml
377+
<appender name="ELK-TCP" class="net.logstash.logback.appender.LogstashTcpSocketAppender">
378+
<!--
379+
destination 是 logstash 服务的 host:port，
380+
相当于和 logstash 建立了管道，将日志数据定向传输到 logstash
381+
-->
382+
<destination>192.168.28.32:9251</destination>
383+
<encoder charset="UTF-8" class="net.logstash.logback.encoder.LogstashEncoder"/>
384+
</appender>
385+
<logger name="io.github.dunwu.spring" level="TRACE" additivity="false">
386+
<appender-ref ref="ELK-TCP" />
387+
</logger>
388+
```
389389

390390
（3）接下来，就是 logback 的具体使用 ，如果对此不了解，不妨参考一下我的这篇博文：[细说 Java 主流日志工具库](https://github.com/dunwu/java-stack/blob/master/docs/javalib/java-log.md) 。
391391

@@ -399,18 +399,18 @@ UDP 和 TCP 的使用方式大同小异。
399399

400400
（1）创建 `logstash-input-udp.conf` ：
401401

402-
```
403-
input {
404-
udp {
405-
port => 9250
406-
codec => json
407-
}
408-
}
409-
output {
410-
elasticsearch { hosts => ["localhost:9200"] }
411-
stdout { codec => rubydebug }
412-
}
413-
```
402+
```
403+
input {
404+
udp {
405+
port => 9250
406+
codec => json
407+
}
408+
}
409+
output {
410+
elasticsearch { hosts => ["localhost:9200"] }
411+
stdout { codec => rubydebug }
412+
}
413+
```
414414

415415
更多配置项可以参考：https://www.elastic.co/guide/en/logstash/current/plugins-inputs-udp.html
416416

@@ -425,15 +425,15 @@ UDP 和 TCP 的使用方式大同小异。
425425

426426
（2）接着，在 logback.xml 中添加 appender
427427

428-
```xml
429-
<appender name="ELK-UDP" class="net.logstash.logback.appender.LogstashSocketAppender">
430-
<host>192.168.28.32</host>
431-
<port>9250</port>
432-
</appender>
433-
<logger name="io.github.dunwu.spring" level="TRACE" additivity="false">
434-
<appender-ref ref="ELK-UDP" />
435-
</logger>
436-
```
428+
```xml
429+
<appender name="ELK-UDP" class="net.logstash.logback.appender.LogstashSocketAppender">
430+
<host>192.168.28.32</host>
431+
<port>9250</port>
432+
</appender>
433+
<logger name="io.github.dunwu.spring" level="TRACE" additivity="false">
434+
<appender-ref ref="ELK-UDP" />
435+
</logger>
436+
```
437437

438438
（3）接下来，就是 logback 的具体使用 ，如果对此不了解，不妨参考一下我的这篇博文：[细说 Java 主流日志工具库](https://github.com/dunwu/java-stack/blob/master/docs/javalib/java-log.md) 。
439439

0 commit comments

Comments
 (0)