java 記号文字のエスケープ処理について

Question

###前提・実現したいこと

javaで禁則文字チェックを作成しています。

禁則文字はプロパティで保持し、javaで取得した際にエスケープが必要な文字が含まれていた場合は
その文字に対してエスケープ処理をしたいです。

禁則文字の一覧は変更可能な設定のため、プロパティの禁則文字じたいにエスケープ処理はいれられません。
あくまでJavaで取得した後に、エスケープ処理をいれたいです。

１．プロパティで保持する禁則文字 ： !"#*$%&'()-^@[;:],./
２．エスケープが必要な文字 ： ¥ * + . ? { } ( ) [ ] ^ $ - | "

上記「1.」で取得した禁則文字列内に「2.」に該当する文字がある場合は、エスケープ処理を施したいです。

エスケープ前の文字列：!"#$%&'()-^@[;:],./
エスケープ後の文字列：!"#*$%&'()-^@[;:],./\

###該当のソースコード
public static void main(String[] args) throws IOException {

BufferedReader br = new BufferedReader(new InputStreamReader(System.in));
while (true) {
	System.out.println("文字列を入力してください。");
	String str = br.readLine();
	idCheck(str);
}

}

private static void idCheck(String i) {

// 禁則文字
String str = "!"#$%&'()-^\@[;:],./\"

// ここにエスケープ処理を実装したいです

if (i.matches(".*[" + str + "]+.*")) {// ここで違反文字を判定
	System.out.println("NG");
} else {
	System.out.println("OK");
}

}

Comments

[A-pZ]

エスケープ処理を施したいことはわかりましたが、エスケープ処理をした後に期待する動作がかかれていません。

[rs516]

ご指摘ありがとうございます。処理後の期待結果を追記しました。

[yuba]

禁則文字は削除、エスケープ対象文字はバックスラッシュでエスケープということでしょうか？
しかし、禁則のはずの " がエスケープされて残っているようです。これは例の誤りですか？

[rs516]

質問が分かりにくく申し訳ございません。
実施したい事は単純に禁則文字にエスケープ対象があった場合はバックスラッシュでエスケープしたいだけです。
サンプルコードにエスケープ処理のロジックは記載していません。

下記の文字列についてエスケープ対象となる文字をバックスラッシュでエスケープしたいです。
// 禁則文字
String str = "!"#$%&'()-^\@[;:],./\"

Answer 1

エスケープ処理

String str = "(?=[-\\\\*+.?{}()\\[\\]^&|\"])";
i = i.replaceAll(str, "\\\\");

先読みで特定の文字を見つけたらその前に\を挟む処理です。
こういうことでよろしいでしょうか。
間違っていましたら指摘をお願いします。

\\ってなっているのは、String型のエスケープと正規表現のエスケープが重なっているためです。

Comments

[rs516]

ありがとうございます。
エスケープ処理後の期待する結果は正に１行目のものです。
私の質問が分かりづらく申し訳ないのですが、今回は事前に禁則文字にエスケープ文字を追加しておくことができないという前提があります。
エスケープなしの禁則文字を取得した後に、エスケープ処理を施したいです。
禁則文字の文字列を１文字ずつ確認し、エスケープ処理を実装するしかないのかと考え中です。

[intelf___]

＞エスケープ処理後の期待する結果は正に１行目のものです。
一行目は処理後の結果ではなく処理のための正規表現文字列です。

つまりはこういうことで
i = i.replaceAll("(?=[-\\\\*+.?{}()\\[\\]^&|\"])", "\\\\");
ソースコード中のコメント
// ここにエスケープ処理を実装したいです
の部分にこのコードを埋め込むことで動作します。

Answer 2

1文字ずつ確認しながら、StringBuilderに入れていくしかないと思います。クラスにしたらこんな感じかなというのを作りました。StringEscaper#escapeStringの所を参考にしてみてください。エスケープ対象の文字はHashSet<Character>に入れておくと良いと思います。ただ、HashSetは同期化されませんのでマルチスレッドで変更される場合は気をつけてください。

/**
 * 文字エスケープ処理
 * U+1000-U+10FFFFの拡張領域には非対応。チェックもしない。
 * スレッドセーフではない。
 */

import java.util.Set;
import java.util.HashSet;
import java.util.Collection;
import java.io.BufferedReader;
import java.io.InputStreamReader;
import java.io.IOException;

public class StringEscaper {
  private Set<Character> escapeTargetCharacterSet;
  private Character escapeCharacter = '\\';

  public StringEscaper() {
    this.escapeTargetCharacterSet = new HashSet<Character>();
  }

  public StringEscaper(String escapeTaregtStr) {
    this(escapeTaregtStr.toCharArray());
  }

  public StringEscaper(Collection<Character> escapeTaregtCharacterCollection) {
    this();
    for (final Character c: escapeTaregtCharacterCollection) {
      this.add(c);
    }
  }

  public StringEscaper(char[] escapeTaregtCharArray) {
    this();
    for (final char c: escapeTaregtCharArray) {
      this.add(c);
    }
  }

  public boolean add(char escapeTargetChar) {
    return this.add(new Character(escapeTargetChar));
  }

  public boolean add(Character escapeTargetCharacter) {
    return escapeTargetCharacterSet.add(escapeTargetCharacter);
  }

  public boolean needsEscape(char c) {
    return this.needsEscape(new Character(c));
  }

  public boolean needsEscape(Character character) {
    return this.escapeTargetCharacterSet.contains(character);
  }

  public String escapeString(String str) {
    StringBuilder builder = new StringBuilder();
    for (final char c: str.toCharArray()) {
      if (this.needsEscape(c)) {
        builder.append(this.escapeCharacter);
      }
      builder.append(c);
    }
    return builder.toString();
  }

  public static void main(String[] args) {
    String target = "\\*+.?{}()[]^$-|\"";
    StringEscaper stringEscaper = new StringEscaper(target);
    BufferedReader br = new BufferedReader(new InputStreamReader(System.in));
    while(true) {
      try {
        System.out.println("文字を入力してください。");
        String line = br.readLine();
        if (line == null) {
          break;
        }
        System.out.println(stringEscaper.escapeString(line));
      } catch (IOException e) {
        break;
      }
    }
  }
}

Comments

[rs516]

サンプルコードまで書いて頂きありがとうございます。
まさに私の実装したい内容です。やはり1文字ずつ確認していくしかない様ですね。
srcを解析しつつ参考にさせて頂きます。

Answer 3

Commons-langのStringUtils#replaceEach を使うと良いでしょうか。

Apache Commonsを使わずに自分で実装を記述したい場合はまた別ですが。

Comments

[rs516]

ありがとうございます。
まさに実装したい内容はご提示のメソッドで実現できそうなのですが、
Apache Commonsライブラリを利用せずに実現する方法はないでしょうか？
質問ばかりで申し訳ございません。

[退会済みユーザー]

逆に言うと、Apache Commonsはオープンソースなので、ソースが公開されています。
そのソースを見て、自分なりのコードを作るってのも１つの勉強方法ですね。

[rs516]

ありがとうございます。
Apache Commonsのsrcダウンロードしました。
勉強用にsrc解析してみたいと思います。