JavaでStringのスペルミスを防ぎたい

Question

私のプロジェクトでは、下記のようなコードが複数のJavaファイルにわたって存在します。

List<String> list_code = Arrays.asList("ABW","AFG","AGO","AIA","ALA","ALB","AND","ARE","ARG","ARM","ASM","ATA","ATF","ATG","AUS","AUT","AZE","BDI","BEL","BEN","BES","BFA","BGD","BGR","BHR","BHS","BIH","BLM","BLR","BLZ","BMU","BOL","BRA","BRB","BRN","BTN","BVT","BWA","CAF","CAN","CCK","CHE","CHL","CHN","CIV","CMR","COD","COG","COK","COL","COM","CPV","CRI","CUB","CUW","CXR","CYM","CYP","CZE","DEU","DJI","DMA","DNK","DOM","DZA","ECU","EGY","ERI","ESH","ESP","EST","ETH","FIN","FJI","FLK","FRA","FRO","FSM","GAB","GBR","GEO","GGY","GHA","GIB","GIN","GLP","GMB","GNB","GNQ","GRC","GRD","GRL","GTM","GUF","GUM","GUY","HKG","HMD","HND","HRV","HTI","HUN","IDN","IMN","IND","IOT","IRL","IRN","IRQ","ISR","ITA","JAM","JEY","JOR","JPN","KAZ","KEN","KGZ","KHM","KIR","KNA","KOR","KWT","LAO","LBN","LBR","LBY","LCA","LIE","LKA","LSO","LTU","LUX","LVA","MAC","MAF","MAR","MCO","MDA","MDG","MDV","MEX","MHL","MKD","MLI","MLT","MMR","MNE","MNG","MNP","MOZ","MRT","MSR","MTQ","MUS","MWI","MYS","MYT","NAM","NCL","NER","NFK","NGA","NIC","NIU","NLD","NOR","NPL","NRU","NZL","OMN","PAK","PAN","PCN","PER","PHL","PLW","PNG","POL","PRI","PRK","PRT","PRY","PSE","PYF","QAT","REU","ROU","RUS","RWA","SAU","SDN","SEN","SGP","SGS","SHN","SJM","SLB","SLE","SLV","SMR","SOM","SPM","SRB","SSD","STP","SUR","SVK","SVN","SWE","SWZ","SXM","SYC","SYR","TCA","TCD","TGO","THA","TJK","TKL","TKM","TLS","TON","TTO","TUN","TUR","TUV","TWN","TZA","UGA","UKR","UMI","URY","USA","UZB","VAT","VCT","VEN","VGB","VIR","VNM","VUT","WLF","WSM","YEM","ZAF","ZMB","ZWE");

if(list_code.contains("NAM")){
...
}

私が心配しているのが、deleteキーやBackSpaceキーによって変更されてしまわないかと言うことです。

そこで考えられるのが、定数専門のJavaファイルを作って下記のように入力して見るというものです。

	public final String ABW = "ABW";
	public final String AFG = "AFG";
	public final String AGO = "AGO";

そうすればEclipseなどではエラーが表示されるのでわかりやすいです。

List<String> list_code = Arrays.asList(ABW,AFG,AGO,AIA,ALA,ALB,AND,ARE,ARG,ARM,ASM,ATA,ATF,ATG,AUS,AUT,AZE,BDI,BEL,BEN,BES,BFA,BGD,BGR,BHR,BHS,BIH,BLM,BLR,BLZ,BMU,BOL,BRA,BRB,BRN,BTN,BVT,BWA,CAF,CAN,CCK,CHE,CHL,CHN,CIV,CMR,COD,COG,COK,COL,COM,CPV,CRI,CUB,CUW,CXR,CYM,CYP,CZE,DEU,DJI,DMA,DNK,DOM,DZA,ECU,EGY,ERI,ESH,ESP,EST,ETH,FIN,FJI,FLK,FRA,FRO,FSM,GAB,GBR,GEO,GGY,GHA,GIB,GIN,GLP,GMB,GNB,GNQ,GRC,GRD,GRL,GTM,GUF,GUM,GUY,HKG,HMD,HND,HRV,HTI,HUN,IDN,IMN,IND,IOT,IRL,IRN,IRQ,ISR,ITA,JAM,JEY,JOR,JPN,KAZ,KEN,KGZ,KHM,KIR,KNA,KOR,KWT,LAO,LBN,LBR,LBY,LCA,LIE,LKA,LSO,LTU,LUX,LVA,MAC,MAF,MAR,MCO,MDA,MDG,MDV,MEX,MHL,MKD,MLI,MLT,MMR,MNE,MNG,MNP,MOZ,MRT,MSR,MTQ,MUS,MWI,MYS,MYT,NAM,NCL,NER,NFK,NGA,NIC,NIU,NLD,NOR,NPL,NRU,NZL,OMN,PAK,PAN,PCN,PER,PHL,PLW,PNG,POL,PRI,PRK,PRT,PRY,PSE,PYF,QAT,REU,ROU,RUS,RWA,SAU,SDN,SEN,SGP,SGS,SHN,SJM,SLB,SLE,SLV,SMR,SOM,SPM,SRB,SSD,STP,SUR,SVK,SVN,SWE,SWZ,SXM,SYC,SYR,TCA,TCD,TGO,THA,TJK,TKL,TKM,TLS,TON,TTO,TUN,TUR,TUV,TWN,TZA,UGA,UKR,UMI,URY,USA,UZB,VAT,VCT,VEN,VGB,VIR,VNM,VUT,WLF,WSM,YEM,ZAF,ZMB,ZWE);

ただもっといい方法があるのではないかと思い、質問させていただきました。何か知恵がありましたら拝借したいと思います。よろしくお願いいたします。

Comments

[dodox86]

> deleteキーやBackSpaceキーによって変更されてしまわないか

ご質問の意図が少々分からないのですが、ソースコードの追加、修正などで間違って修正されて、気が付かないで作業を進めてしまうような事故を防ぎたいということでしょうか。

[退会済みユーザー]

現時点では enum だな

[tiqua_nibio]

>気が付かないで作業を進めてしまうような事故を防ぎたいということでしょうか。

はい。そういうことです。実のところ、これはDBのカラム名です。ですので、containsなもののみアップデートするようなメソッドを使っています。

[dodox86]

修正箇所を集中させる目的で定数をまとめたクラスに書くことはありましたが、プログラミング作業中のうっかり事故を防ぐ目的で考えたことはまったくありませんでしたね。Gitのようなソースコード管理システムでガードする範囲のように思いましたが。投稿される（かもしれない）回答にちょっと興味があります。（私自身は回答を持たないので、このコメントのみで失礼します）

[cateye]

よくわからないので、質問ですが？
> 複数のJavaファイルにわたって存在〜
というのは、同じ記述を含むソースファイルが複数有るという事でしょうか

[tiqua_nibio]

> というのは、同じ記述を含むソースファイルが複数有るという事でしょうか

はい、そうです。Arrays.asListの中に入るパターンも色々と変わります。

Answer 1

私が心配しているのが、deleteキーやBackSpaceキーによって変更されてしまわないかと言うことです。

人間がコードを打っている以上、100%防ぐのは無理なので、「起きにくい仕組み」「起きた時に捕捉する方法」「起きた後のリカバリー」を加味した工程を組むしかありません。
既に出ているようにEnumにするところがいいところでしょうけど、全てに対して適切な策とは限りません。
「簡単にキー操作で変更できない」となるともういっそ全てDBに持ってしまうとか（色々と煩雑になると思うけど）

でも値を変えるということは何かに変化が起きるので、それはそれでどこかのタイミングで気づけそうなものですけど。
JUnitなどできちんとテスト書いてinput/outputの整合性を確認するようにすれば良いかと。

Comments

[tiqua_nibio]

ありがとうございます。インターフェースに列記することで、運用することにしてみます。

Answer 2

asahina1979さんがおっしゃってるように、
Enumで定義すればよいのではないでしょうか？

例)
public enum ColumnIndex {
    ABW,
    AFG,
    AGO,
　　  (省略)
    ;
}

• 定義を追加する場所が固定される
• values()で定義している値全てを配列で取得できる
• name()でenum宣言で宣言されているとおりのenum定数の名前を取得できる
• 必要ならJavadoc付けて意味を説明できる
• switch文とかにも使える

などなど、利点はあるかと思います。
そもそも、長く羅列させるのがバグを生む原因かと。

Arrays.asList()の引数にvalues()すれば羅列しなくても一発ですね。
リストの中身を毎回変える必要がないなら、Enumクラスにリストも定義しておけばいいんじゃないですかね。

ん？values()でfor文回せばリスト要らないかも！？

Comments

[tiqua_nibio]

ありがとうございます。　enumに記載するというのも一つの方法かと思われます。

その後で、
final String __aaa = ColumnIndex.aaa.name();
というのを並べて使えるようにするという方法をインターフェースでやろうと思います。なぜ、インターフェースかというと、変数の前にドットでクラス名・インスタンス名をつけなくても済むからです。
JSPの場合は、これができませんので素直に="aaa"で並べました。

[kaputaros]

> なぜ、インターフェースかというと、変数の前にドットでクラス名・インスタンス名をつけなくても済むからです。

ん？「import static」を使えばイケませんか？
まあ、解決されたのであればそれでも。