添加输出游戏调试日志选项 #4144
+124
−5
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -459,6 +459,20 @@ public void setShowLogs(boolean showLogs) { | |||||||||||
| showLogsProperty.set(showLogs); | ||||||||||||
| } | ||||||||||||
|
|
||||||||||||
| private final BooleanProperty showDebugLogsProperty = new SimpleBooleanProperty(this, "showDebugLogs", false); | ||||||||||||
|
|
||||||||||||
| public BooleanProperty showDebugLogsProperty() { | ||||||||||||
| return showDebugLogsProperty; | ||||||||||||
| } | ||||||||||||
|
|
||||||||||||
|
There was a problem hiding this comment. The new method isEnableDebugLogOutput() lacks JavaDoc documentation while the similar method isShowLogs() above it has documentation. For consistency and clarity, consider adding documentation like: "/** * True if debug level logging should be enabled in log4j2 configuration. */" to explain what this option does.
Suggested change
|
||||||||||||
| public boolean isShowDebugLogsOutput() { | ||||||||||||
| return showDebugLogsProperty.get(); | ||||||||||||
| } | ||||||||||||
|
|
||||||||||||
| public void setShowDebugLogs(boolean u) { | ||||||||||||
| this.showDebugLogsProperty.set(u); | ||||||||||||
| } | ||||||||||||
|
|
||||||||||||
| // Minecraft settings. | ||||||||||||
|
|
||||||||||||
| private final StringProperty serverIpProperty = new SimpleStringProperty(this, "serverIp", ""); | ||||||||||||
|
|
@@ -775,6 +789,7 @@ public JsonElement serialize(VersionSetting src, Type typeOfSrc, JsonSerializati | |||||||||||
| obj.addProperty("notCheckJVM", src.isNotCheckJVM()); | ||||||||||||
| obj.addProperty("notPatchNatives", src.isNotPatchNatives()); | ||||||||||||
| obj.addProperty("showLogs", src.isShowLogs()); | ||||||||||||
| obj.addProperty("showDebugLogs", src.isShowDebugLogsOutput()); | ||||||||||||
| obj.addProperty("gameDir", src.getGameDir()); | ||||||||||||
| obj.addProperty("launcherVisibility", src.getLauncherVisibility().ordinal()); | ||||||||||||
| obj.addProperty("processPriority", src.getProcessPriority().ordinal()); | ||||||||||||
|
|
@@ -845,6 +860,7 @@ public VersionSetting deserialize(JsonElement json, Type typeOfT, JsonDeserializ | |||||||||||
| vs.setNotCheckJVM(Optional.ofNullable(obj.get("notCheckJVM")).map(JsonElement::getAsBoolean).orElse(false)); | ||||||||||||
| vs.setNotPatchNatives(Optional.ofNullable(obj.get("notPatchNatives")).map(JsonElement::getAsBoolean).orElse(false)); | ||||||||||||
| vs.setShowLogs(Optional.ofNullable(obj.get("showLogs")).map(JsonElement::getAsBoolean).orElse(false)); | ||||||||||||
| vs.setShowDebugLogs(Optional.ofNullable(obj.get("showDebugLogs")).map(JsonElement::getAsBoolean).orElse(false)); | ||||||||||||
| vs.setLauncherVisibility(parseJsonPrimitive(obj.getAsJsonPrimitive("launcherVisibility"), LauncherVisibility.class, LauncherVisibility.HIDE)); | ||||||||||||
| vs.setProcessPriority(parseJsonPrimitive(obj.getAsJsonPrimitive("processPriority"), ProcessPriority.class, ProcessPriority.NORMAL)); | ||||||||||||
| vs.setUseNativeGLFW(Optional.ofNullable(obj.get("useNativeGLFW")).map(JsonElement::getAsBoolean).orElse(false)); | ||||||||||||
|
|
||||||||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|
|
|
@@ -64,6 +64,7 @@ public class LaunchOptions implements Serializable { | |||||||||||
| private Renderer renderer = Renderer.DEFAULT; | ||||||||||||
| private boolean useNativeGLFW; | ||||||||||||
| private boolean useNativeOpenAL; | ||||||||||||
| private boolean showDebugLog; | ||||||||||||
| private boolean daemon; | ||||||||||||
|
|
||||||||||||
| /** | ||||||||||||
|
|
@@ -282,6 +283,10 @@ public boolean isUseNativeOpenAL() { | |||||||||||
| return useNativeOpenAL; | ||||||||||||
| } | ||||||||||||
|
|
||||||||||||
|
There was a problem hiding this comment. The new method isEnableDebugLogOutput() lacks JavaDoc documentation. While some similar methods like isUseNativeGLFW() also lack documentation, many other getter methods in this class have JavaDoc comments explaining their purpose (e.g., isDaemon(), isNoGeneratedJVMArgs()). Consider adding documentation like: "/** * Whether to enable debug level logging output in log4j2 configuration. */" to explain what this option does.
Suggested change
|
||||||||||||
| public boolean isShowDebugLog() { | ||||||||||||
| return showDebugLog; | ||||||||||||
| } | ||||||||||||
|
|
||||||||||||
| /** | ||||||||||||
| * Will launcher keeps alive after game launched or not. | ||||||||||||
| */ | ||||||||||||
|
|
@@ -497,5 +502,9 @@ public Builder setDaemon(boolean daemon) { | |||||||||||
| return this; | ||||||||||||
| } | ||||||||||||
|
|
||||||||||||
| public Builder setShowDebugLog(boolean u) { | ||||||||||||
| options.showDebugLog = u; | ||||||||||||
| return this; | ||||||||||||
| } | ||||||||||||
| } | ||||||||||||
| } | ||||||||||||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -148,9 +148,14 @@ private Command generateCommandLine(Path nativeFolder) throws IOException { | |
| res.addDefault("-Dcom.sun.jndi.rmi.object.trustURLCodebase=", "false"); | ||
| res.addDefault("-Dcom.sun.jndi.cosnaming.object.trustURLCodebase=", "false"); | ||
|
|
||
| if (options.isShowDebugLog()) { | ||
| res.addDefault("-Dlog4j2.formatMsgNoLookups=", "false"); | ||
CiiLu marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
| res.addDefault("-Dlog4j.configurationFile=", FileUtils.getAbsolutePath(getLog4jConfigurationFile())); | ||
| } else { | ||
| String formatMsgNoLookups = res.addDefault("-Dlog4j2.formatMsgNoLookups=", "true"); | ||
|
||
| if (!"-Dlog4j2.formatMsgNoLookups=false".equals(formatMsgNoLookups) && isUsingLog4j()) { | ||
| res.addDefault("-Dlog4j.configurationFile=", FileUtils.getAbsolutePath(getLog4jConfigurationFile())); | ||
| } | ||
| } | ||
|
|
||
| // Default JVM Args | ||
|
|
@@ -421,14 +426,23 @@ public Path getLog4jConfigurationFile() { | |
|
|
||
| public void extractLog4jConfigurationFile() throws IOException { | ||
| Path targetFile = getLog4jConfigurationFile(); | ||
|
|
||
| StringBuilder sourcePathBuilder = new StringBuilder("/assets/game/log4j2-"); | ||
CiiLu marked this conversation as resolved.
Outdated
Show resolved
Hide resolved
|
||
|
|
||
| if (GameVersionNumber.asGameVersion(repository.getGameVersion(version)).compareTo("1.12") < 0) { | ||
| sourcePathBuilder.append("1.7"); | ||
| } else { | ||
| sourcePathBuilder.append("1.12"); | ||
| } | ||
|
|
||
| if (options.isShowDebugLog()) { | ||
| sourcePathBuilder.append("-debug"); | ||
| } | ||
|
|
||
| sourcePathBuilder.append(".xml"); | ||
| String sourcePath = sourcePathBuilder.toString(); | ||
|
|
||
| try (InputStream input = DefaultLauncher.class.getResourceAsStream(sourcePath)) { | ||
| Files.copy(input, targetFile, StandardCopyOption.REPLACE_EXISTING); | ||
|
Comment on lines
+441
to
442
There was a problem hiding this comment. The InputStream returned by getResourceAsStream could be null if the resource file is not found. The code should add a null check (similar to the pattern used in MaintainTask.java line 166) to provide a clearer error message if the bundled log4j configuration file is missing. Consider using Objects.requireNonNull(input, "Bundled log4j2 configuration is missing.") before passing it to Files.copy. |
||
| } | ||
| } | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,37 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <Configuration status="warn" packages=""> | ||
| <Appenders> | ||
| <Console name="SysOut" target="SYSTEM_OUT"> | ||
| <PatternLayout pattern="[%d{HH:mm:ss}] [%t/%level]: %msg{nolookups}%n" /> | ||
| </Console> | ||
| <Queue name="ServerGuiConsole"> | ||
| <PatternLayout pattern="[%d{HH:mm:ss} %level]: %msg{nolookups}%n" /> | ||
| </Queue> | ||
| <RollingRandomAccessFile name="File" fileName="logs/latest.log" filePattern="logs/%d{yyyy-MM-dd}-%i.log.gz"> | ||
| <PatternLayout pattern="[%d{HH:mm:ss}] [%t/%level] [%logger]: %msg{nolookups}%n"/> | ||
| <Policies> | ||
| <TimeBasedTriggeringPolicy/> | ||
| <OnStartupTriggeringPolicy/> | ||
| </Policies> | ||
| </RollingRandomAccessFile> | ||
| <RollingRandomAccessFile name="DebugFile" fileName="logs/debug.log" filePattern="logs/debug-%d{yyyy-MM-dd}-%i.log.gz"> | ||
| <PatternLayout pattern="[%d{yyyy-MM-dd HH:mm:ss}] [%t/%level] [%logger]: %msg{nolookups}%n"/> | ||
| <Policies> | ||
| <TimeBasedTriggeringPolicy/> | ||
| <OnStartupTriggeringPolicy/> | ||
| </Policies> | ||
| <DefaultRolloverStrategy max="999" fileIndex="min"/> | ||
| </RollingRandomAccessFile> | ||
| </Appenders> | ||
| <Loggers> | ||
| <Root level="all"> | ||
| <filters> | ||
| <MarkerFilter marker="NETWORK_PACKETS" onMatch="DENY" onMismatch="NEUTRAL"/> | ||
| </filters> | ||
| <AppenderRef ref="SysOut" level="info"/> | ||
| <AppenderRef ref="ServerGuiConsole" level="info"/> | ||
| <AppenderRef ref="File" level="info"/> | ||
| <AppenderRef ref="DebugFile" level="all"/> | ||
| </Root> | ||
| </Loggers> | ||
| </Configuration> |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,36 @@ | ||
| <?xml version="1.0" encoding="UTF-8"?> | ||
| <Configuration status="WARN"> | ||
| <Appenders> | ||
| <Console name="SysOut" target="SYSTEM_OUT"> | ||
| <PatternLayout pattern="[%d{HH:mm:ss}] [%t/%level]: %msg%n" /> | ||
| </Console> | ||
| <Queue name="ServerGuiConsole"> | ||
| <PatternLayout pattern="[%d{HH:mm:ss} %level]: %msg%n" /> | ||
| </Queue> | ||
| <RollingRandomAccessFile name="File" fileName="logs/latest.log" filePattern="logs/%d{yyyy-MM-dd}-%i.log.gz"> | ||
| <PatternLayout pattern="[%d{HH:mm:ss}] [%t/%level] [%logger]: %msg%n"/> | ||
| <Policies> | ||
| <TimeBasedTriggeringPolicy/> | ||
| <OnStartupTriggeringPolicy/> | ||
| </Policies> | ||
| </RollingRandomAccessFile> | ||
| <RollingRandomAccessFile name="DebugFile" fileName="logs/debug.log" filePattern="logs/debug-%d{yyyy-MM-dd}-%i.log.gz"> | ||
| <PatternLayout pattern="[%d{yyyy-MM-dd HH:mm:ss}] [%t/%level] [%logger]: %msg%n"/> | ||
| <Policies> | ||
| <TimeBasedTriggeringPolicy/> | ||
| <OnStartupTriggeringPolicy/> | ||
| </Policies> | ||
| </RollingRandomAccessFile> | ||
| </Appenders> | ||
| <Loggers> | ||
| <Root level="all"> | ||
| <filters> | ||
| <MarkerFilter marker="NETWORK_PACKETS" onMatch="DENY" onMismatch="NEUTRAL"/> | ||
| </filters> | ||
| <AppenderRef ref="SysOut" level="info"/> | ||
| <AppenderRef ref="ServerGuiConsole" level="info"/> | ||
| <AppenderRef ref="File" level="info"/> | ||
| <AppenderRef ref="DebugFile" level="all"/> | ||
| </Root> | ||
| </Loggers> | ||
| </Configuration> |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.