Java如何用单个DocumentFilter限制JTextField允许字符与输入长度

完全可以，单个DocumentFilter就能同时实现JTextField的输入字符范围限制、总长度限制，不需要叠加多个过滤器。
DocumentFilter本身会拦截所有对文档内容的修改操作（包括键盘逐字输入、粘贴文本、程序调用API修改文本），只需要在拦截逻辑里按顺序加入两层校验规则即可。

实现要点 #

• 必须同时重写insertString（插入文本场景）和replace（替换选中文本、粘贴文本场景）两个方法，只重写其中一个会出现限制被绕过的问题
• 长度校验逻辑：先计算操作完成后的总文本长度 = 当前文档长度 - 本次操作删除/替换的原有文本长度 + 待插入的新文本长度，如果超过设定的最大长度，可选择直接拦截操作、或者截断超长部分后再写入
• 字符范围校验逻辑：遍历待插入的所有字符，判断是否属于允许输入的范围，可选择直接过滤掉非法字符后写入、或者拦截包含非法字符的整次写入操作

可直接运行的示例代码 #

import javax.swing.text.AttributeSet;
import javax.swing.text.BadLocationException;
import javax.swing.text.DocumentFilter;
import javax.swing.text.AbstractDocument;
import javax.swing.JTextField;

public class CombinedLimitFilter extends DocumentFilter {
    private final int maxLength;
    private final String allowedChars;

    /**
     * 组合限制过滤器
     * @param maxLength 允许输入的最大总长度
     * @param allowedChars 允许输入的字符集合，传入null则不做字符范围限制
     */
    public CombinedLimitFilter(int maxLength, String allowedChars) {
        this.maxLength = maxLength;
        this.allowedChars = allowedChars;
    }

    @Override
    public void insertString(FilterBypass fb, int offset, String text, AttributeSet attr) throws BadLocationException {
        // 插入场景等价于替换长度为0的文本，直接复用replace的校验逻辑避免重复代码
        replace(fb, offset, 0, text, attr);
    }

    @Override
    public void replace(FilterBypass fb, int offset, int length, String text, AttributeSet attrs) throws BadLocationException {
        if (text == null) {
            text = "";
        }
        // 第一层校验：过滤不在允许范围内的非法字符
        String filteredText;
        if (allowedChars != null) {
            StringBuilder sb = new StringBuilder();
            for (char c : text.toCharArray()) {
                if (allowedChars.indexOf(c) != -1) {
                    sb.append(c);
                }
            }
            filteredText = sb.toString();
        } else {
            filteredText = text;
        }

        // 第二层校验：校验总长度，截断超长部分
        int currentLen = fb.getDocument().getLength();
        int remainLen = maxLength - (currentLen - length);
        if (remainLen <= 0) {
            return;
        }
        if (filteredText.length() > remainLen) {
            filteredText = filteredText.substring(0, remainLen);
        }

        // 校验完成执行实际写入
        super.replace(fb, offset, length, filteredText, attrs);
    }
}

使用方式 #

给目标JTextField配置过滤器即可，比如实现最多输入6位数字的限制：

JTextField textField = new JTextField();
// 参数1：最大输入长度6，参数2：仅允许输入0-9数字
((AbstractDocument) textField.getDocument()).setDocumentFilter(
        new CombinedLimitFilter(6, "0123456789")
);

这个实现可以覆盖所有输入场景，不会出现粘贴绕过限制、选中文本替换时长度计算错误的问题。如果需要更灵活的字符规则，也可以把allowedChars的判断逻辑换成正则表达式匹配即可。

内容的提问来源于stack exchange，提问作者Korenji