win10系统下IDEA启动Tomcat日志乱码

拼搏现实的明天。 2023-01-13 10:56 300阅读 0赞

## 1. 缘起 ##

最近重装了win10系统，导致IDEA设置都丢失了，打开Java Web项目，启动Tomcat，日志又是乱码。这是第N次遇上，之前都是从网上搜索答案，只知道管用，不知道为什么，这次折腾了一波，比之前明白了一些。

环境：

*  Win10
 *  JDK8
 *  Tomcat9
 *  IDEA 2021.1

## 2. Tomcat ##

第一，根据tomcat安装包下的RUNNING.txt的说明，手动启动Tomcat的命令有这几个：

cd D:\programs\server\apache-tomcat-9.0.45\bin
    catalina.bat start
    catalina.bat run
    startup.bat

catalina start 和 startup 脚本，会另起一个cmd窗口运行tomcat服务  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW54aXpoYW4xOTk1_size_16_color_FFFFFF_t_70_pic_center]  
而 catalina.bat run 则是在当前cmd窗口直接运行tomcat，就这一点区别。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW54aXpoYW4xOTk1_size_16_color_FFFFFF_t_70_pic_center 1]  
第二，关于日志。根据tomcat官网文档，默认配置下，Tomcat的日志会同时向控制台和catalina.out各输出一份。所以在cmd控制台上输出的内容和catalina.out文件的内容几乎是一样的。  
PS：文档建议在生产环境调整设置，因为两份一样的日志信息是不必要的。  
但这两处日志的输出编码是分别由两个配置项控制的，打开文件 `$CATALINA_BASE}/conf/logging.properties`，可以看到这两个配置项：  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW54aXpoYW4xOTk1_size_16_color_FFFFFF_t_70_pic_center 2]  
如图，ConsoleHandler设置的是cmd命令行的编码，而AsyncFileHandler控制的是catalina.out的日志i编码。  
PS：tomcat9中，这两处的初始值都是UTF-8.

### 附：consolehandler的编码和cmd编码不一致，控制台会乱码 ###

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW54aXpoYW4xOTk1_size_16_color_FFFFFF_t_70_pic_config]  
要么调整tomcat设置，要么调整cmd代码页：

![调整tomcat控制台日志编码][tomcat]  
![调整cmd编码][cmd]

## 3. IDEA ##

用IDEA开发Java Web程序时，基本都会设置一个tomcat server类型的run/debug config项，用于实时调试程序。  
![在这里插入图片描述][20210418204937920.png_pic_center]配置完成后，运行启动tomcat，IDEA会把tomcat的日志回显在下方工具窗口中。  
Tomcat输出到控制台的日志（就是上面提到的cmd窗口的日志）会在IDEA名为server的日志标签页显示；  
Tomcat的catalina.out日志文件的内容则会在IDEA的名为Tomcat Calalina log 的标签页中显示（参见[IDEA文档][IDEA]）。  
如下图：  
![IDEA日志和tomcat日志对应关系][IDEA_tomcat]  
如果乱码，就是IDEA和tomcat的配置不一致导致的。

前文已经确定了Tomcat中设置这两处编码的配置项。现在看一下IDEA中，这两处的编码是怎么配置的。

第一处，那个标注Server的日志页，在IDEA中叫做console，配置路径是`File | Settings | Editor | General | Console | Default Encoding`，它默认是System default。  
PS：System default 的实际值跟随当前操作系统默认编码设置（用file.encoding可以覆盖操作系统默认编码）。  
PPS：换个说法，System default 的实际取值跟随file.encoding的设置，如果没有设置file.encoding,则是GBK（中国大陆Windows系统）。  
![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW54aXpoYW4xOTk1_size_16_color_FFFFFF_t_70]  
所以让tomcat的Consolehandler.encoding和IDEA的console encoding保持一致此处就不会乱码。

第二处，标志Tomcat Catalina Log的日志页，它对应Tomcat的`1catalina.org.apache.juli.AsyncFileHandler.encoding`设置。但是我没有找到  
在IDEA  
如何设置这一处的编码，只知道IDEA的这个编码跟随操作系统默认编码（同时使用 file.encoding可以覆盖操作系统默认编码）。

找到了原因，就可以着手处理问题了：

1.  IDEA的console encoding和Tomcat的ConsoleHandler.encoding都设置成UTF-8
2.  不设置IDEA的file.encoding参数，让它保持默认值GBK，Tomcat的`1catalina.org.apache.juli.AsyncFileHandler.encoding` 设置成GBK。

我没有选择设置IDEA的file.encoding参数的原因：设置file.encoding影响范围太大了，为了改一个日志编码，把IDEA全局的系统默认编码都给改了，不大放心，谨慎起见，修改Tomcat吧。

## 4. 附：设置IDEA的file.encoding ##

1.  如果IDEA能正常打开，使用菜单 Help | Edit Custom VM Options，在打开的编辑器中，插入一行 `-Dfile.encoding=GBK`（或者=UTF-8）。

![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW54aXpoYW4xOTk1_size_16_color_FFFFFF_t_70_pic_center 3]![在这里插入图片描述][watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW54aXpoYW4xOTk1_size_16_color_FFFFFF_t_70_pic_center 4]  
2. 如果IDEA不能正常启动，先想办法启动起来`:)`.

## 5. 其它 ##

1.  有没有哪里可以设置IDEA读取Tomcat的catalina.out日志时使用的编码？
2.  IDEA可以设置单个控制台的编码吗？

哪位知道答案，烦请留言告知。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW54aXpoYW4xOTk1_size_16_color_FFFFFF_t_70_pic_center]: /images/20221022/6c14cbaa2a624484bc09f21ca989bf2c.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW54aXpoYW4xOTk1_size_16_color_FFFFFF_t_70_pic_center 1]: /images/20221022/45718cbc80034a26a731b2cc38538349.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW54aXpoYW4xOTk1_size_16_color_FFFFFF_t_70_pic_center 2]: /images/20221022/2be9acd8020d49deb602559fc90bad49.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW54aXpoYW4xOTk1_size_16_color_FFFFFF_t_70_pic_config]: /images/20221022/79cc3d2cce0b4ad98a952bb24abf6b38.png
[tomcat]: /images/20221022/043cc008c66d4d1a949233e8ea685650.png
[cmd]: /images/20221022/535697cc6a3441849f3334f543fc1ad6.png
[20210418204937920.png_pic_center]: /images/20221022/227c01c530b248af8c0bb2c6e8fcc8ee.png
[IDEA]: https://www.jetbrains.com/help/idea/2021.1/setting-log-options.html
[IDEA_tomcat]: /images/20221022/058edaa63160437da9a7c405ad3ea195.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW54aXpoYW4xOTk1_size_16_color_FFFFFF_t_70]: /images/20221022/484910c264754bc49c3306fd6e8c5394.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW54aXpoYW4xOTk1_size_16_color_FFFFFF_t_70_pic_center 3]: https://img-blog.csdnimg.cn/2021041821302540.png?x-oss-process=image/watermark,type_ZmFuZ3poZW5naGVpdGk,shadow_10,text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW54aXpoYW4xOTk1,size_16,color_FFFFFF,t_70#pic_center
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L2NoZW54aXpoYW4xOTk1_size_16_color_FFFFFF_t_70_pic_center 4]: /images/20221022/99757442dd384d649725afc3d2a53b9e.png