JFormattedTextField输入限制与验证技巧

在使用 Swing 的 `JFormattedTextField` 组件进行格式化输入时，直接获取文本长度可能包含格式化掩码字符，导致验证不准确。本文针对这一问题，提供了两种有效解决方案，帮助开发者准确获取用户实际输入的字符长度，并进行有效的数据校验。**方法一：移除所有空格字符**，适用于保留部分格式字符校验的场景；**方法二：仅保留数字字符**，通过正则表达式彻底提取纯数字部分，适用于严格校验数字位数的场景。掌握这些方法，能有效解决 `JFormattedTextField` 与 `MaskFormatter` 结合使用时的长度问题，确保数据输入的合法性和准确性。选择合适的方法，提升用户体验，让你的应用更专业！

JFormattedTextField 与 MaskFormatter 的长度问题

JFormattedTextField 是 Swing 中用于格式化输入的组件，它通常与 MaskFormatter 结合使用，以强制用户按照特定格式输入数据（例如电话号码、日期等）。然而，当用户输入数据后，调用 ftf.getText() 方法获取到的字符串会包含 MaskFormatter 定义的所有字符，包括用户未输入时被占位符填充的部分，以及格式化字符本身（如 (, ), -, 空格）。

例如，对于电话号码格式 (###) ###-####，即使用户只输入了部分数字，getText() 也可能返回一个包含所有掩码字符的字符串。当所有数字都输入完毕，如 (123) 456-7890，其 getText().length() 会是 14。如果我们需要验证用户是否输入了全部 10 位数字，直接检查 length() 显然是不准确的。

解决方案：去除掩码字符获取真实长度

为了准确获取用户实际输入的字符长度，我们需要对 JFormattedTextField 返回的字符串进行后处理，去除其中的掩码字符。以下介绍两种常用的方法：

方法一：移除所有空格字符

如果掩码中包含空格，并且这些空格是影响长度判断的主要因素，可以通过移除所有空格来获取一个更接近实际输入的字符串长度。

import javax.swing.*;
import javax.swing.text.MaskFormatter;
import java.awt.*;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.text.ParseException;

public class PhoneBookValidator extends JFrame implements ActionListener {

    private JFormattedTextField phoneField;
    private JTextField nameField;
    private JButton createButton;
    private JTextArea messageArea;

    public PhoneBookValidator() throws ParseException {
        setTitle("电话簿验证示例");
        setDefaultCloseOperation(JFrame.EXIT_ON_CLOSE);
        setSize(400, 300);
        setLayout(null);
        setResizable(false);

        JLabel nameLabel = new JLabel("姓名:");
        nameLabel.setBounds(30, 20, 80, 25);
        add(nameLabel);

        nameField = new JTextField();
        nameField.setBounds(100, 20, 200, 25);
        add(nameField);

        JLabel phoneLabel = new JLabel("电话:");
        phoneLabel.setBounds(30, 60, 80, 25);
        add(phoneLabel);

        MaskFormatter phoneMask = new MaskFormatter("(###) ###-####");
        // 允许不完全输入时保留占位符，如果需要完全输入才能提交，可以设置为 false
        // phoneMask.setPlaceholderCharacter('_'); 
        phoneField = new JFormattedTextField(phoneMask);
        phoneField.setBounds(100, 60, 200, 25);
        add(phoneField);

        createButton = new JButton("创建联系人");
        createButton.setBounds(100, 120, 150, 30);
        createButton.addActionListener(this);
        add(createButton);

        messageArea = new JTextArea();
        messageArea.setBounds(30, 170, 340, 80);
        messageArea.setEditable(false);
        messageArea.setLineWrap(true);
        messageArea.setWrapStyleWord(true);
        add(messageArea);

        setVisible(true);
    }

    @Override
    public void actionPerformed(ActionEvent e) {
        if (e.getSource() == createButton) {
            String name = nameField.getText().trim();
            String phoneRaw = phoneField.getText();

            // 1. 移除所有空格字符
            String phoneNoSpaces = phoneRaw.replaceAll("\\s+", ""); 

            // 对于掩码 (###) ###-####，移除空格后，期望的完整长度是 13 (10位数字 + 2个括号 + 1个连字符)
            // 如果用户未完全输入，phoneNoSpaces 仍然会包含占位符和掩码字符。
            // 例如，输入 (123) 456-7890 长度为 14，移除空格后为 (123)456-7890 长度为 13。
            // 验证时需要确保长度等于期望的完整长度，且不包含占位符。

            if (name.isEmpty()) {
                messageArea.setText("错误：姓名不能为空！");
                return;
            }

            // 检查电话号码是否完整
            // 这里假设完整的电话号码在移除空格后，其长度应为 13，且不包含掩码的占位符（如 #）
            // 更精确的验证请参考方法二
            if (phoneNoSpaces.length() < 13 || phoneNoSpaces.contains("#")) {
                messageArea.setText("错误：电话号码输入不完整或格式不正确！");
            } else {
                messageArea.setText("联系人创建成功！\n姓名: " + name + "\n电话: " + phoneRaw);
            }
        }
    }

    public static void main(String[] args) {
        SwingUtilities.invokeLater(() -> {
            try {
                new PhoneBookValidator();
            } catch (ParseException e) {
                e.printStackTrace();
            }
        });
    }
}

注意事项： 此方法只移除了空格。如果你的掩码中包含其他非数字字符（如括号、连字符），这些字符仍会保留在字符串中。因此，你需要根据掩码的完整形式来判断期望的长度。例如，对于 (###) ###-####，移除空格后，完整的字符串长度应为 13。这种方法适用于你希望保留部分格式化字符进行校验的情况。

方法二：仅保留数字字符

这是最推荐的方法，因为它能够完全剥离所有非数字的掩码字符，只留下用户实际输入的数字。这对于校验纯数字输入（如电话号码、身份证号）非常有效。

import javax.swing.*;
import javax.swing.text.MaskFormatter;
import java.awt.event.ActionEvent;
import java.awt.event.ActionListener;
import java.text.ParseException;

// ... (PhoneBookValidator 类的其他部分保持不变)

    @Override
    public void actionPerformed(ActionEvent e) {
        if (e.getSource() == createButton) {
            String name = nameField.getText().trim();
            String phoneRaw = phoneField.getText();

            // 2. 仅保留数字字符
            String phoneDigitsOnly = phoneRaw.replaceAll("[^0-9]+", "");

            // 对于电话号码，我们期望输入 10 位数字
            // 如果用户未完全输入，phoneDigitsOnly 的长度会小于 10。

            if (name.isEmpty()) {
                messageArea.setText("错误：姓名不能为空！");
                return;
            }

            // 检查电话号码是否完整（10位数字）
            if (phoneDigitsOnly.length() != 10) {
                messageArea.setText("错误：电话号码必须是 10 位数字！");
            } else {
                messageArea.setText("联系人创建成功！\n姓名: " + name + "\n电话: " + phoneDigitsOnly); // 显示纯数字电话
            }
        }
    }

// ... (main 方法保持不变)

注意事项： 此方法使用正则表达式 [^0-9]+ 来匹配一个或多个非数字字符，并将其替换为空字符串。这样，无论掩码中包含空格、括号、连字符还是其他符号，都会被移除，最终只剩下纯粹的数字字符串。这种方法最为精确，适用于需要严格校验数字数量的场景。

总结

当 JFormattedTextField 结合 MaskFormatter 使用时，直接获取 getText().length() 无法准确反映用户实际输入的字符数量。通过字符串的 replaceAll() 方法，我们可以有效地去除掩码字符，从而得到用户实际输入内容的真实长度。

• replaceAll("\\s+", ""): 适用于需要移除空格，但保留其他格式字符（如括号、连字符）进行校验的场景。校验时需要根据期望的完整格式长度来判断。
• replaceAll("[^0-9]+", ""): 这是最推荐的方法，能够彻底提取出用户输入的纯数字部分，适用于需要严格校验数字位数的场景。校验时只需判断提取出的数字字符串的长度是否符合预期。

在实际应用中，建议根据具体的业务需求和 MaskFormatter 的定义，选择最合适的字符串处理方法来确保数据校验的准确性。

本篇关于《JFormattedTextField输入限制与验证技巧》的介绍就到此结束啦，但是学无止境，想要了解学习更多关于文章的相关知识，请关注golang学习网公众号！