Java中规模软件开发实训——简单的文本编辑器（代码注释详解）

package文本编辑器;
importjavax.swing.*;
importjavax.swing.border.Border;
importjavax.swing.event.DocumentEvent;
importjavax.swing.event.DocumentListener;
importjavax.swing.text.AttributeSet;
importjavax.swing.text.SimpleAttributeSet;
importjavax.swing.text.StyleConstants;
importjavax.swing.text.StyleContext;
importjavax.swing.undo.UndoManager;
importjava.awt.*;
importjava.awt.event.*;
importjava.io.*;
publicclassCodeEditorextendsJFrame {
// 声明私有成员变量privateJTextPanecodePane;              // 代码编辑区域privateJTextArealineNumberArea;        // 行号显示区域privateJButtoncompileButton;           // 编译按钮privateJButtonrunButton;               // 运行按钮privateJFileChooserfileChooser;        // 文件选择器privateJMenuthemeMenu;                 // 主题菜单privateJMenuItemlightThemeItem;        // 亮色主题菜单项privateJMenuItemdarkThemeItem;         // 暗色主题菜单项privateJMenueditMenu;                  // 编辑菜单privateJMenuItemfontColorItem;         // 字体颜色菜单项privateJMenuItemfontSizeItem;          // 字体大小菜单项privateUndoManagerundoManager;         // 撤销管理器privatedoublezoomScale=1.0;          // 缩放比例/*** 构造函数，创建一个代码编辑器窗口。*/publicCodeEditor() {
setTitle("文本编译器");                        // 设置窗口标题setSize(800, 600);                             // 设置窗口大小setDefaultCloseOperation(EXIT_ON_CLOSE);      // 设置窗口关闭时的默认操作为退出应用程序// 创建主面板JPanelmainPanel=newJPanel(newBorderLayout());
getContentPane().add(mainPanel);
codePane=newJTextPane();                     // 创建代码编辑区域lineNumberArea=newJTextArea("1");            // 创建行号显示区域lineNumberArea.setBackground(Color.LIGHT_GRAY);
lineNumberArea.setEditable(false);//lineNumberArea.setEditable(false); 将 lineNumberArea 设置为不可编辑，意味着用户无法通过键盘输入或编辑该文本区域中的内容。lineNumberArea.setFocusable(false);//lineNumberArea.setFocusable(false); 将 lineNumberArea 设置为不可获取焦点，意味着用户无法通过点击或键盘操作将焦点聚焦在该文本区域上。//这段代码的作用是为 lineNumberArea 文本区域设置一个带有黄色边框和内边距的边框样式。Borderborder=BorderFactory.createMatteBorder(0, 0, 0, 5, Color.yellow);//创建了一个 MatteBorder 对象，该边框在右侧有5个像素的黄色边框，而其他三个边界没有边框。这个边框对象被赋值给 border 变量。lineNumberArea.setBorder(BorderFactory.createCompoundBorder(border, BorderFactory.createEmptyBorder(0, 5, 0, 5)));//将 lineNumberArea 的边框设置为一个复合边框。这个复合边框由两个部分组成：第一个部分是之前创建的 MatteBorder 对象 border，它定义了右侧的黄色边框；第二个部分是一个空边框 BorderFactory.createEmptyBorder(0, 5, 0, 5)，它在内部创建了一个没有任何边框的空白区域，其上、下、左、右各有5个像素的空白。通过将这两个边框组合在一起，实现了一个具有黄色边框和内边距的边框效果。//创建滚动条JScrollPanecodeScrollPane=newJScrollPane(codePane);//创建了一个名为 codeScrollPane 的滚动窗格，并将 codePane 添加到其中。codePane 是一个文本区域或其他可滚动的组件，通过将其添加到滚动窗格中，可以在需要时启用滚动功能，以便在需要时浏览大量的文本内容。JScrollPanelineNumberScrollPane=newJScrollPane(lineNumberArea);//创建了一个名为 lineNumberScrollPane 的滚动窗格，并将 lineNumberArea 添加到其中。lineNumberArea 是另一个文本区域或可滚动的组件，它可能是用于显示行号的区域。同样，将其添加到滚动窗格中可以实现在需要时滚动内容。lineNumberScrollPane.setVerticalScrollBarPolicy(JScrollPane.VERTICAL_SCROLLBAR_NEVER);//设置了 lineNumberScrollPane 的垂直滚动条策略。JScrollPane.VERTICAL_SCROLLBAR_NEVER 指示不显示垂直滚动条。这意味着在 lineNumberScrollPane 中，即使内容超过可见区域，也不会显示垂直滚动条。//显示行号codeScrollPane.setRowHeaderView(lineNumberScrollPane);//将 lineNumberScrollPane 设置为 codeScrollPane 的行头视图，用于显示行号mainPanel.add(codeScrollPane, BorderLayout.CENTER);      // 将代码编辑区域和行号显示区域添加到主面板的中心位置// 创建按钮面板JPanelbuttonPanel=newJPanel();
compileButton=newJButton("编译");            // 创建编译按钮runButton=newJButton("运行");                // 创建运行按钮buttonPanel.add(compileButton);
buttonPanel.add(runButton);
mainPanel.add(buttonPanel, BorderLayout.SOUTH);         // 将按钮面板添加到主面板的南部位置fileChooser=newJFileChooser();               // 创建文件选择器//创建菜单栏JMenuBarmenuBar=newJMenuBar();               // 创建菜单栏JMenufileMenu=newJMenu("文件");               // 创建文件菜单JMenuItemopenItem=newJMenuItem("打开");      // 创建打开菜单项JMenuItemsaveItem=newJMenuItem("保存");      // 创建保存菜单项fileMenu.add(openItem);
fileMenu.add(saveItem);
menuBar.add(fileMenu);
//同上themeMenu=newJMenu("主题");                    // 创建主题菜单lightThemeItem=newJMenuItem("白色");           // 创建亮色主题菜单项darkThemeItem=newJMenuItem("粉色");            // 创建暗色主题菜单项themeMenu.add(lightThemeItem);
themeMenu.add(darkThemeItem);
menuBar.add(themeMenu);
//同上editMenu=newJMenu("编辑");                     // 创建编辑菜单fontColorItem=newJMenuItem("文字颜色");         // 创建字体颜色菜单项fontSizeItem=newJMenuItem("文字大小");          // 创建字体大小菜单项editMenu.add(fontColorItem);
editMenu.add(fontSizeItem);
menuBar.add(editMenu);
//解释：setJMenuBar(menuBar); 是一个 Swing 窗口的方法调用，用于将给定的菜单栏（menuBar）设置为窗口的菜单栏。setJMenuBar(menuBar);                            // 设置菜单栏// 注册事件监听器//e -> openFile() 表示一个处理事件的函数或方法。当事件被触发时，该函数会被调用，并执行 openFile() 方法来处理打开文件的操作。openItem.addActionListener(e->openFile());                   // 注册打开菜单项的点击事件监听器saveItem.addActionListener(e->saveFile());                   // 注册保存菜单项的点击事件监听器compileButton.addActionListener(e->compileCode());           // 注册编译按钮的点击事件监听器runButton.addActionListener(e->runCode());                   // 注册运行按钮的点击事件监听器lightThemeItem.addActionListener(e->setLightTheme());        // 注册亮色主题菜单项的点击事件监听器darkThemeItem.addActionListener(e->setDarkTheme());          // 注册暗色主题菜单项的点击事件监听器fontColorItem.addActionListener(e->setFontColor());          // 注册字体颜色菜单项的点击事件监听器fontSizeItem.addActionListener(e->setFontSize());            // 注册字体大小菜单项的点击事件监听器// 注册文本内容变化监听器//显示行号的监听事件codePane.getDocument().addDocumentListener(newDocumentListener() {
publicvoidchangedUpdate(DocumentEvente) {
updateLineNumbers();                                    // 文本内容发生改变时更新行号显示            }
publicvoidinsertUpdate(DocumentEvente) {
updateLineNumbers();                                    // 文本内容插入时更新行号显示            }
publicvoidremoveUpdate(DocumentEvente) {
updateLineNumbers();                                    // 文本内容删除时更新行号显示            }
        });
//创建了一个 UndoManager 对象来管理撤销和恢复操作，并将其与 codePane 的文档关联起来，以便在文档发生可撤销的编辑操作时进行记录和管理。这样，用户可以通过调用 undoManager 的方法来撤销和恢复编辑操作的历史记录。//撤销操作undoManager=newUndoManager();
codePane.getDocument().addUndoableEditListener(e->undoManager.addEdit(e.getEdit()));   // 注册撤销操作监听器//为 codePane 添加了一个键盘监听器，用于处理用户按键事件，并实现了对撤销和重做操作的响应。//通过键盘进行撤销codePane.addKeyListener(newKeyAdapter() {
@OverridepublicvoidkeyPressed(KeyEvente) {
if (e.isControlDown()) {//e.isControlDown() 检查用户是否按下了 Ctrl 键。if (e.getKeyCode() ==KeyEvent.VK_Z) {//通过 e.getKeyCode() 获取按下的键的键码。if (undoManager.canUndo()) {
undoManager.undo();                           // Ctrl+Z 撤销操作                        }
                    } elseif (e.getKeyCode() ==KeyEvent.VK_Y) {
if (undoManager.canRedo()) {
undoManager.redo();                           // Ctrl+Y 重做操作                        }
                    }
                }
            }
        });
//通过鼠标滑轮控制字体大小codePane.addMouseWheelListener(newMouseAdapter() {
@OverridepublicvoidmouseWheelMoved(MouseWheelEvente) {
if (e.isControlDown()) {//e.isControlDown() 检查用户是否按下了 Ctrl 键。intnotches=e.getWheelRotation();//e.getWheelRotation() 获取鼠标滚轮的滚动方向，返回的值可以是正数或负数。if (notches<0) {
zoomIn();                                         // Ctrl+鼠标滚轮向上缩放文本                    } else {
zoomOut();                                        // Ctrl+鼠标滚轮向下缩放文本                    }
e.consume();
                }
            }
        });
    }
/*** 放大文本缩放比例。*/privatevoidzoomIn() {
zoomScale+=0.1;                               // 将缩放比例增加0.1applyZoom();                                    // 应用新的缩放比例    }
/*** 缩小文本缩放比例。*/privatevoidzoomOut() {
zoomScale-=0.1;                               // 将缩放比例减少0.1applyZoom();                                    // 应用新的缩放比例    }
/*** 应用当前的缩放比例到代码编辑区域的字体大小。*/privatevoidapplyZoom() {
if (zoomScale<0.1) {
zoomScale=0.1;                            // 缩放比例不低于0.1        }
codePane.setFont(codePane.getFont().deriveFont((float) (codePane.getFont().getSize() *zoomScale)));   // 根据缩放比例设置新的字体大小    }
/*** 更新行号显示区域的内容，根据当前代码编辑区域的行数进行更新。*/privatevoidupdateLineNumbers() {
Stringcode=codePane.getText();                                // 获取当前代码编辑区域的文本内容intlines=code.split("\n", -1).length;                         // 计算行数，使用换行符作为分隔符进行拆分     具体解释：具体来说，code.split("\n", -1) 使用换行符 (\n) 将字符串 code 拆分成多个行，并返回一个包含拆分后的子字符串的数组。第二个参数 -1 表示在拆分过程中保留所有空行。然后，.length 方法用于获取拆分后的字符串数组的长度，即行数。因此，int lines = code.split("\n", -1).length; 将计算出字符串 code 中的行数，并将其存储在 lines 变量中。StringBuilderlineNumbers=newStringBuilder();                // 用于存储行号内容的字符串构建器for (inti=1; i<=lines; i++) {
lineNumbers.append(i).append("\n");                          // 将行号添加到字符串构建器中，并添加换行符        具体解释：lineNumbers.append(i).append("\n"); 表示将行号 i 和换行符 "\n" 连接起来，并将它们追加到字符串构建器 lineNumbers 的末尾。append() 是字符串构建器的方法，用于将指定的内容添加到构建器的末尾。在这里，lineNumbers.append(i) 将行号 i 添加到字符串构建器中，然后 append("\n") 将换行符 "\n" 添加到字符串构建器中，实现行号和换行符的连接。        }
lineNumberArea.setText(lineNumbers.toString());                  // 将行号内容设置到行号显示区域    }
/*** 打开文件操作，选择文件并将文件内容读取到代码编辑区域中。*/privatevoidopenFile() {
intreturnValue=fileChooser.showOpenDialog(this);               // 显示文件选择对话框，并获取用户的操作结果if (returnValue==JFileChooser.APPROVE_OPTION) {//如果用户选择了打开文件的操作（returnValue == JFileChooser.APPROVE_OPTION），则继续执行打开文件的操作。FileselectedFile=fileChooser.getSelectedFile();           // 获取用户选择的文件   详细解释：通过 fileChooser.getSelectedFile() 获取用户选择的文件，并将其存储在 selectedFile 变量中。try {
BufferedReaderreader=newBufferedReader(newFileReader(selectedFile));   // 创建文件读取器  详细解释：使用 BufferedReader 类来创建一个文件读取器 (reader)，并将选择的文件作为参数传递给它StringBuildercontent=newStringBuilder();             // 用于存储文件内容的字符串构建器 详细解释：创建一个 StringBuilder 对象 content，用于存储文件内容。通过循环读取文件中的每一行，并将其逐行添加到 content 字符串构建器中。Stringline;
while ((line=reader.readLine()) !=null) {
content.append(line).append("\n");                    // 逐行读取文件内容，并添加到字符串构建器中                }
reader.close();                                          // 关闭文件读取器 读取文件完成后，关闭文件读取器 (reader.close())。codePane.setText(content.toString());                     // 将文件内容设置到代码编辑区域中    将 content.toString() 得到的文件内容字符串设置为代码编辑区域 (codePane) 的文本，即显示文件内容在代码编辑区域中。            } catch (IOExceptione) {
e.printStackTrace();
            }
        }
    }
/*** 保存文件操作，将代码编辑区域的内容保存到文件中。*/privatevoidsaveFile() {
intreturnValue=fileChooser.showSaveDialog(this);                      // 显示文件保存对话框，并获取用户的操作结果if (returnValue==JFileChooser.APPROVE_OPTION) {
FileselectedFile=fileChooser.getSelectedFile();                   // 获取用户选择的文件try {
FileWriterwriter=newFileWriter(selectedFile);                // 创建文件写入器writer.write(codePane.getText());                                 // 将代码编辑区域的内容写入文件writer.close();                                                   // 关闭文件写入器            } catch (IOExceptione) {
e.printStackTrace();
            }
        }
    }
/*** 编译代码操作，将代码编辑区域的内容保存到名为 "Main.java" 的文件中，并调用系统命令行执行 javac 命令进行编译。* 根据编译结果显示编译成功或编译失败的消息对话框。*/privatevoidcompileCode() {
Stringcode=codePane.getText();                                         // 获取代码编辑区域的文本内容try {
Filefile=newFile("Main.java");                                    // 创建名为 "Main.java" 的文件FileWriterwriter=newFileWriter(file);                             // 创建文件写入器writer.write(code);                                                   // 将代码写入文件writer.close();                                                       // 关闭文件写入器Processprocess=Runtime.getRuntime().exec("javac Main.java");        // 调用系统命令行执行 javac 命令进行编译intexitCode=process.waitFor();                                      // 等待编译进程结束，并获取退出码if (exitCode==0) {
JOptionPane.showMessageDialog(this, "编译成功！");                // 编译成功，显示编译成功的消息对话框            } else {
JOptionPane.showMessageDialog(this, "编译失败！");                // 编译失败，显示编译失败的消息对话框            }
        } catch (Exceptione) {
e.printStackTrace();
        }
    }
/*** 运行代码操作，调用系统命令行执行 "java Main" 命令运行编译后的代码，并获取代码运行的输出结果。* 将输出结果显示在消息对话框中。*/privatevoidrunCode() {
try {
Processprocess=Runtime.getRuntime().exec("java Main");               // 调用系统命令行执行 "java Main" 命令运行编译后的代码BufferedReaderreader=newBufferedReader(newInputStreamReader(process.getInputStream()));  // 创建用于读取代码运行输出的字符缓冲读取器StringBuilderoutput=newStringBuilder();                            // 用于存储代码运行输出结果的字符串构建器Stringline;
while ((line=reader.readLine()) !=null) {
output.append(line).append("\n");                                  // 逐行读取代码运行输出，并添加到字符串构建器中            }
JOptionPane.showMessageDialog(this, "输出结果：\n"+output.toString());   // 显示运行结果的消息对话框，包含代码运行的输出结果        } catch (Exceptione) {
e.printStackTrace();
        }
    }
/*** 设置浅色主题，将代码编辑区域和行号区域的背景颜色调整为相应的浅色。*/privatevoidsetLightTheme() {
codePane.setBackground(Color.white);                     // 将代码编辑区域的背景颜色设置为白色lineNumberArea.setBackground(Color.LIGHT_GRAY);          // 将行号区域的背景颜色设置为浅灰色    }
/*** 设置粉色主题，将代码编辑区域和行号区域的背景颜色调整为相应的暗色。*/privatevoidsetDarkTheme() {
codePane.setBackground(Color.pink);                      // 将代码编辑区域的背景颜色设置为粉色lineNumberArea.setBackground(Color.GRAY);                // 将行号区域的背景颜色设置为灰色    }
/*** 设置文字颜色，通过颜色选择器选择新的文字颜色，并将其应用到代码编辑区域的前景色。* 用户选择颜色后，将选中的颜色设置为代码编辑区域的前景色。*/privatevoidsetFontColor() {
ColorselectedColor=JColorChooser.showDialog(this, "选择文字颜色", codePane.getForeground());  // 打开颜色选择器对话框，获取用户选择的颜色/*详细解释：代码中的 JColorChooser.showDialog(this, "选择文字颜色",*  codePane.getForeground()) 表示在当前界面 (this) 上显示一个颜色选择器对话框。对话框的标题是 "选择文字颜色"，*  并且默认选中的颜色是 codePane 的前景色（文本颜色）。*  当用户在颜色选择器对话框中选择了一个颜色后，JColorChooser.showDialog() 方法会返回用户选择的颜色值，*  并将其存储在 selectedColor 变量中。*/if (selectedColor!=null) {
codePane.setForeground(selectedColor);               // 将选中的颜色设置为代码编辑区域的前景色        }
    }
/*** 设置字体大小，通过输入对话框获取用户输入的字体大小，并将其应用到代码编辑区域的字体。* 用户输入的字体大小应为正整数，如果输入无效或不是正整数，将显示相应的错误消息对话框。*/privatevoidsetFontSize() {
Stringinput=JOptionPane.showInputDialog(this, "请输入字体大小:", codePane.getFont().getSize());  // 打开输入对话框，获取用户输入的字体大小   //JOptionPane.showInputDialog() 方法会返回用户输入的字体大小，并将其存储在 input 变量中。try {
intfontSize=Integer.parseInt(input);                                 // 将用户输入的字体大小转换为整数  通过 Integer.parseInt(input) 将用户输入的字体大小转换为整数，并存储在 fontSize 变量中。if (fontSize>0) {//通过条件判断 fontSize > 0 来验证用户输入的字体大小是否有效。如果字体大小大于 0，则执行以下操作：FontcurrentFont=codePane.getFont();//codePane.getFont() 获取当前代码编辑区域的字体。codePane.setFont(newFont(currentFont.getFontName(), currentFont.getStyle(), fontSize));  // 将新的字体大小应用到代码编辑区域的字体//创建一个新的 Font 对象，并将原字体的字体名称、字体样式以及新的字体大小应用到该对象中。使用 codePane.setFont() 方法将新的字体设置为代码编辑区域的字体。            } else {
//如果字体大小无效（小于等于 0），则使用 JOptionPane.showMessageDialog(this, "无效的字体大小。请输入一个正整数。") 显示一个错误消息对话框，提示用户输入一个有效的字体大小。JOptionPane.showMessageDialog(this, "无效的字体大小。请输入一个正整数。");      // 显示无效字体大小的错误消息对话框            }
        } catch (NumberFormatExceptione) {
JOptionPane.showMessageDialog(this, "无效输入。请输入有效的字体大小。");           // 显示无效输入的错误消息对话框        }
    }
/*** 主方法，程序的入口点。在Swing事件调度线程中创建并显示代码编辑器。* 在主方法中，使用SwingUtilities.invokeLater() 方法调度创建和显示代码编辑器的任务，* 确保在正确的线程上进行Swing组件的创建和更新操作。*/publicstaticvoidmain(String[] args) {
/** 使用 SwingUtilities.invokeLater() 方法* 来确保在事件分派线程（Event Dispatch Thread）中执行代码。* 这是因为 Swing 组件需要在事件分派线程中进行操作，以保证界面的响应性和线程安全性。* */SwingUtilities.invokeLater(() -> {
/** SwingUtilities.invokeLater(() -> {...})* 使用 Lambda 表达式创建一个 Runnable 对象，其中的代码会在事件分派线程中执行。*/CodeEditoreditor=newCodeEditor();  // 创建代码编辑器对象editor.setVisible(true);              // 设置代码编辑器可见        });
    }
}