9

我最近注意到 Java 文本组件使用换行符（LF、\n、 0x0A）在内部表示和解释换行符。这让我感到非常惊讶，并提出了我的假设，即在任何地方使用System.getProperty('line.separator') 都是一种很好的做法，这是一个问号。

看起来，每当您处理文本组件时，在使用上述属性时都应该非常小心，因为如果您使用JTextComponent.setText(String)，您最终可能会得到一个包含不可见换行符（例如 CR）的组件。这似乎并不重要，除非文本组件的内容可以保存到文件中。如果您使用所有文本组件提供的方法将文本保存并打开到文件中，则隐藏的换行符会在重新打开文件时突然在组件中实现。原因似乎是该JTextComponent.read(...)方法进行了标准化。

那么为什么不对JTextComponent.setText(String)行尾进行规范化呢？或者任何其他允许在文本组件中修改文本的方法？System.getProperty('line.separator')在处理文本组件时使用一种好的做法吗？这是一个好习惯吗？

一些代码可以透视这个问题：

import java.awt.GridBagConstraints;
import java.awt.GridBagLayout;
import java.awt.Insets;
import java.awt.event.ActionEvent;
import java.io.File;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStreamReader;
import java.io.OutputStreamWriter;
import java.io.Reader;
import java.io.UnsupportedEncodingException;
import java.io.Writer;
import javax.swing.AbstractAction;
import javax.swing.JButton;
import javax.swing.JFrame;
import javax.swing.JOptionPane;
import javax.swing.JScrollPane;
import javax.swing.JTextArea;
import javax.swing.SwingUtilities;

public class TextAreaTest extends JFrame {

    private JTextArea jtaInput;
    private JScrollPane jscpInput;
    private JButton jbSaveAndReopen;

    public TextAreaTest() {
        super();
        setDefaultCloseOperation(EXIT_ON_CLOSE);
        setTitle("Text Area Test");
        GridBagLayout layout = new GridBagLayout();
        setLayout(layout);        

        jtaInput = new JTextArea();
        jtaInput.setText("Some text followed by a windows newline\r\n"
                + "and some more text.");
        jscpInput = new JScrollPane(jtaInput);
        GridBagConstraints constraints = new GridBagConstraints();
        constraints.gridx = 0; constraints.gridy = 0;
        constraints.gridwidth = 2;
        constraints.weightx = 1.0; constraints.weighty = 1.0;
        constraints.fill = GridBagConstraints.BOTH;
        add(jscpInput, constraints);

        jbSaveAndReopen = new JButton(new SaveAndReopenAction());
        constraints = new GridBagConstraints();
        constraints.gridx = 1; constraints.gridy = 1;
        constraints.anchor = GridBagConstraints.EAST;
        constraints.insets = new Insets(5, 0, 2, 2);
        add(jbSaveAndReopen, constraints);

        pack();
    }

    public static void main(String[] args) {
        SwingUtilities.invokeLater(new Runnable() {

            public void run() {
                TextAreaTest tat = new TextAreaTest();
                tat.setVisible(true);
            }
        });
    }

    private class SaveAndReopenAction extends AbstractAction {

        private File file = new File("text-area-test.txt");

        public SaveAndReopenAction() {
            super("Save and Re-open");
        }

        private void saveToFile() 
                throws UnsupportedEncodingException, FileNotFoundException,
                IOException {

            Writer writer = null;
            try {
                writer = new OutputStreamWriter(
                        new FileOutputStream(file), "UTF-8");
                TextAreaTest.this.jtaInput.write(writer);
            } finally {
                if (writer != null) {
                    try {
                        writer.close();
                    } catch (IOException ex) {
                    }
                }
            }
        }

        private void openFile() 
                throws UnsupportedEncodingException, IOException {
            Reader reader = null;
            try {
                reader = new InputStreamReader(
                        new FileInputStream(file), "UTF-8");
                TextAreaTest.this.jtaInput.read(reader, file);
            } finally {
                if (reader != null) {
                    try {
                        reader.close();
                    } catch (IOException ex) {
                    }
                }
            }
        }

        public void actionPerformed(ActionEvent e) {
            Throwable exc = null;
            try {
                saveToFile();
                openFile();
            } catch (UnsupportedEncodingException ex) {
                exc = ex;
            } catch (FileNotFoundException ex) {
                exc = ex;
            } catch (IOException ex) {
                exc = ex;
            }
            if (exc != null) {
                JOptionPane.showConfirmDialog(
                        TextAreaTest.this, exc.getMessage(), "An error occured",
                        JOptionPane.DEFAULT_OPTION, JOptionPane.ERROR_MESSAGE);
            }
        }        
    }
}

添加新文本行后，此程序在我的 Windows 机器上保存的示例（为什么是单个 CR？o_O）：

在此处输入图像描述

编辑01

我在 Netbeans IDE 中运行/调试了它，它在 Windows 7 上使用 JDK1.7u15 64bit (C:\Program Files\Java\jdk1.7.0_15)。

4

2 回答 2

2

首先，真正的答案是设计师认为设计应该是这样工作的。你真的需要问他们得到真正的原因。

话说回来：

那么为什么 JTextComponent.setText(String) 不对行尾进行规范化呢？

我认为最可能的原因是：

  • 这将是意想不到的行为。大多数程序员会期望1文本字段上的“获取”返回与“设置”......或用户输入的相同字符串值。

  • 如果文本字段确实规范化了，那么程序员将很难将原始文本的行结尾保留在需要这样做的花瓶中。

  • 设计者可能想在某个时候改变主意（参见read和write方法的报告行为）但由于兼容性原因无法改变。

无论如何，如果您需要规范化，没有什么可以阻止您的代码对 setter 检索到的值执行此操作。

或者任何其他允许在文本组件中修改文本的方法？

据报道（见评论）read和/或write进行标准化。

处理文本组件时使用 System.getProperty('line.separator') 是一种好习惯吗？这是一个好习惯吗？

这取决于上下文。如果您知道您正在读取和写入要在“此”平台上处理的文件，这可能是一个好主意。如果文件打算在不同的平台上读取（使用不同的行分隔符），那么规范化以匹配当前机器的约定可能是一个坏主意。

1 - 其他方法喜欢read和write可能表现不同的事实不会影响这一点。他们不是“getter”和“setter”。我说的是人们期望“getter”和“setter”的行为方式......而不是其他任何东西。此外，人们不应该期望一切都以相同的方式表现，除非指定他们这样做。但显然，这里的部分问题是规范...... javadocs......对这些问题保持沉默。

另一种可能性是@predi 报告的规范化行为实际上发生在Reader/Writer对象中......

于 2013-07-26T14:13:19.160 回答
1

使用系统行分隔符是有问题的。我只会用它来编写平台特定格式的文本文件。

阅读时，我总是简单地扔掉任何 '\r', (CR)，有效地将 Windows/Mac/Unix 转换为 Unix 样式的换行符。在内部，我永远不会使用除了普通的 '\n' (LF) 之外的任何东西来指示换行 - 它浪费内存并且只会让处理文本更加痛苦。

于 2013-07-26T14:27:24.813 回答