有用なEclipse Javaコードテンプレートを探す[終了]

EclipseでさまざまなJavaコードテンプレートを作成できます。

ウィンドウ>設定> Java>エディター>テンプレート

例えば

sysout 次のように展開されます：

System.out.println(${word_selection}${});${cursor}

あなたは次のように入力して、これをアクティブにすることができますsysoutが続きますCTRL+SPACE

現在、どのような有用なJavaコードテンプレートを使用していますか？それの名前と説明、そしてそれが素晴らしい理由を含めてください。

組み込みの既存の機能ではなく、テンプレートのオリジナル/新規の使用を探しています。

• Log4Jロガーを作成する
• ディスプレイからSWTカラーを取得
• Syncexec-Eclipseフレームワーク
• シングルトンパターン/列挙型シングルトン生成
• Readfile
• 定数
• 描きます
• フォーマット文字列
• コメントコードレビュー
• 文字列フォーマット
• 最後にロックを試す
• メッセージ形式i18nおよびログ
• Equalsbuilder
• ハッシュコードビルダー
• スプリングオブジェクトインジェクション
• FileOutputStreamを作成する

次のコードテンプレートは、ロガーを作成し、必要に応じて適切なインポートを作成します。

SLF4J

${:import(org.slf4j.Logger,org.slf4j.LoggerFactory)}
private static final Logger LOG = LoggerFactory.getLogger(${enclosing_type}.class);

Log4J 2

${:import(org.apache.logging.log4j.LogManager,org.apache.logging.log4j.Logger)} 
private static final Logger LOG = LogManager.getLogger(${enclosing_type}.class); 

Log4J

${:import(org.apache.log4j.Logger)}
private static final Logger LOG = Logger.getLogger(${enclosing_type}.class);

ソース。

7月

${:import(java.util.logging.Logger)}
private static final Logger LOG = Logger.getLogger(${enclosing_type}.class.getName());

ここではいくつかの追加のテンプレート：リンクI - リンクII

私はこれが好きです：

readfile

 ${:import(java.io.BufferedReader,  
           java.io.FileNotFoundException,  
           java.io.FileReader,  
           java.io.IOException)}  
 BufferedReader in = null;  
 try {  
    in = new BufferedReader(new FileReader(${fileName}));  
    String line;  
    while ((line = in.readLine()) != null) {  
       ${process}  
    }  
 }  
 catch (FileNotFoundException e) {  
    logger.error(e) ;  
 }  
 catch (IOException e) {  
    logger.error(e) ;  
 } finally {  
    if(in != null) in.close();  
 }  
 ${cursor} 

更新：このテンプレートのJava 7バージョンは次のとおりです。

${:import(java.nio.file.Files,
          java.nio.file.Paths,
          java.nio.charset.Charset,
          java.io.IOException,
          java.io.BufferedReader)}
try (BufferedReader in = Files.newBufferedReader(Paths.get(${fileName:var(String)}),
                                                 Charset.forName("UTF-8"))) {
    String line = null;
    while ((line = in.readLine()) != null) {
        ${cursor}
    }
} catch (IOException e) {
    // ${todo}: handle exception
}

文字列をフォーマットする

MessageFormat-選択範囲をMessageFormatで囲みます。

 ${:import(java.text.MessageFormat)} 
 MessageFormat.format(${word_selection}, ${cursor})

これにより、カーソルを文字列に移動し、選択範囲を文字列全体（Shift-Alt-Up）に拡張してから、Ctrl-Spaceを2回押します。

選択をロック

lock-選択した行をtry finally lockで囲みます。ロック変数が存在すると想定します。

${lock}.acquire();
try {
    ${line_selection}
    ${cursor}
} finally {
    ${lock}.release();
}

NB ${line_selection}テンプレートは、Surround Withメニュー（Alt-Shift-Z）に表示されます。

私は死んだポストを蹴っているのを知っていますが、完了のためにこれを共有したいと思います：

欠陥のあるダブルチェックのロック設計を克服する正しいバージョンのシングルトン生成テンプレート（上記で説明し、他の場所で言及）

シングルトン作成テンプレート： これに名前を付けますcreatesingleton

static enum Singleton {
    INSTANCE;

    private static final ${enclosing_type} singleton = new ${enclosing_type}();

    public ${enclosing_type} getSingleton() {
        return singleton;
    }
}
${cursor}

上記を使用して生成されたシングルトンにアクセスするには：

シングルトン参照テンプレート： これに名前を付けますgetsingleton：

${type} ${newName} = ${type}.Singleton.INSTANCE.getSingleton();

反復するコードスニペットを追加しMap.entrySet()ます。

テンプレート：

${:import(java.util.Map.Entry)}
for (Entry<${keyType:argType(map, 0)}, ${valueType:argType(map, 1)}> ${entry} : ${map:var(java.util.Map)}.entrySet())
{
    ${keyType} ${key} = ${entry}.getKey();
    ${valueType} ${value} = ${entry}.getValue();
    ${cursor}
}

生成されたコード：

for (Entry<String, String> entry : properties.entrySet())
{
    String key = entry.getKey();
    String value = entry.getValue();
    |
}

の場合log、メンバー変数に追加するのに役立つ小さな役目を果たします。

private static Log log = LogFactory.getLog(${enclosing_type}.class);

Mockitoでモックを作成します（「Javaステートメント」コンテキストで）：

${:importStatic('org.mockito.Mockito.mock')}${Type} ${mockName} = mock(${Type}.class);

そして「Java型メンバー」では：

${:import(org.mockito.Mock)}@Mock
${Type} ${mockName};

voidメソッドをモックして例外をスローします。

${:import(org.mockito.invocation.InvocationOnMock,org.mockito.stubbing.Answer)}
doThrow(${RuntimeException}.class).when(${mock:localVar}).${mockedMethod}(${args});

voidメソッドをモックして何かを行います：

${:import(org.mockito.invocation.InvocationOnMock,org.mockito.stubbing.Answer)}doAnswer(new Answer<Object>() {
public Object answer(InvocationOnMock invocation) throws Throwable {
    Object arg1 = invocation.getArguments()[0];
    return null;
}
}).when(${mock:localVar}).${mockedMethod}(${args});

偽のメソッドが1回だけ呼び出されたことを確認します。

${:importStatic(org.mockito.Mockito.verify,org.mockito.Mockito.times)}
verify(${mock:localVar}, times(1)).${mockMethod}(${args});

モックされたメソッドが呼び出されないことを確認します。

${:importStatic(org.mockito.Mockito.verify,org.mockito.Mockito.never)}verify(${mock:localVar}, never()).${mockMethod}(${args});

Google Guavaを使用した新しいリンクリスト（およびハッシュセットとハッシュマップについても同様）：

${import:import(java.util.List,com.google.common.collect.Lists)}List<${T}> ${newName} = Lists.newLinkedList();

また、Testクラスを生成する巨大なテンプレートを使用しています。以下は、興味のあるすべての人がカスタマイズする必要がある、その短縮されたフラグメントです。

package ${enclosing_package};

import org.junit.*;
import static org.junit.Assert.*;
import static org.hamcrest.Matchers.*;
import static org.mockito.Matchers.*;
import static org.mockito.Mockito.*;
import org.mockito.Mockito;
import org.slf4j.Logger;
import org.mockito.InjectMocks;
import org.mockito.Mock;
import org.mockito.runners.MockitoJUnitRunner;
import org.junit.runner.RunWith;

// TODO autogenerated test stub
@RunWith(MockitoJUnitRunner.class)
public class ${primary_type_name} {

    @InjectMocks
    protected ${testedType} ${testedInstance};
    ${cursor}

    @Mock
    protected Logger logger;

    @Before
    public void setup() throws Exception {
    }

    @Test
    public void shouldXXX() throws Exception {
        // given

        // when
        // TODO autogenerated method stub

        // then
        fail("Not implemented.");
    }
}
// Here goes mockito+junit cheetsheet

ヌルチェック！

if( ${word_selection} != null ){
    ${cursor}
}

if( ${word_selection} == null ){
    ${cursor}
}

私の最愛の人はforeachです：

for (${iterable_type} ${iterable_element} : ${iterable}) {
    ${cursor}
}

そしてtraceout、私はそれを追跡のためにたくさん使っているので：

System.out.println("${enclosing_type}.${enclosing_method}()");

私は別のものについて考えただけで、インターネット上でそれをいつか見つけました、const：

private static final ${type} ${name} = new ${type} ${cursor};

sysoutに関するちょっとしたヒント-私はそれを "sop"に改名したい。「sop」で始まるjava libsの他のものは何もないので、「sop」とすばやく入力してブームを挿入できます。

現在のスコープ（illarg）に変数を持つIllegalArgumentExceptionをスローします。

throw new IllegalArgumentException(${var});

より良い

throw new IllegalArgumentException("Invalid ${var} " + ${var});  

コード生成には特別なことはありませんが、コードレビューには非常に役立ちます。

テンプレートcoderevを低/中/高にして、次のようにします

/**
 * Code Review: Low Importance
 * 
 *
 * TODO: Insert problem with code here 
 *
 */

次に、[タスク]ビューで、会議中に持ち出したいすべてのコードレビューコメントを表示します。

ここにいくつかのテンプレートがあります。

含まれるもの：

• 特定の日付から日付オブジェクトを作成する
• 新しいジェネリックArrayListを作成する
• ロガーのセットアップ
• 指定したレベルのログ
• 新しい汎用HashMapを作成する
• マップを反復処理し、キーと値を出力します
• SimpleDateFormatを使用して時間を解析する
• 1行ずつファイルを読み取る
• キャッチした例外をログに記録して再スローする
• コードブロックの実行時間を出力する
• 定期的なタイマーを作成する
• 文字列をファイルに書き込む

slf4jロギング

${imp:import(org.slf4j.Logger,org.slf4j.LoggerFactory)}

private static final Logger LOGGER = LoggerFactory
    .getLogger(${enclosing_type}.class);

Beanプロパティ

private ${Type} ${property};

public ${Type} get${Property}() {
    return ${property};
}

public void set${Property}(${Type} ${property}) {
    ${propertyChangeSupport}.firePropertyChange("${property}", this.${property},     this.${property} = ${property});
}

PropertyChangeSupport

private PropertyChangeSupport ${propertyChangeSupport} = new PropertyChangeSupport(this);${:import(java.beans.PropertyChangeSupport,java.beans.PropertyChangeListener)}
public void addPropertyChangeListener(PropertyChangeListener listener) {
  ${propertyChangeSupport}.addPropertyChangeListener(listener);
}

public void addPropertyChangeListener(String propertyName, PropertyChangeListener listener) {
  ${propertyChangeSupport}.addPropertyChangeListener(propertyName, listener);
}

public void removePropertyChangeListener(PropertyChangeListener listener) {
  ${propertyChangeSupport}.removePropertyChangeListener(listener);
}

public void removePropertyChangeListener(String propertyName, PropertyChangeListener listener) {
  ${propertyChangeSupport}.removePropertyChangeListener(propertyName, listener);
}

ポストJava 7は、包含クラスへの静的参照を必要とする（または好む）ロガーを設定する優れた方法として、新しく導入されたMethodHandles APIを使用して、静的コンテキストでランタイムクラスを取得します。

SLF4Jのサンプルスニペットは次のとおりです。

private static final Logger logger = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());

どのIDEでも単純なスニペットであるだけでなく、特定の機能を別のクラスにリファクタリングしても、クラス名が誤って持ち運ばれることがないので、壊れにくくなります。

GUIスレッドでコードを呼び出す

次のテンプレートをショートカットにバインドslaterして、GUIスレッドでコードをすばやくディスパッチします。

${:import(javax.swing.SwingUtilities)}
SwingUtilities.invokeLater(new Runnable() {      
      @Override
      public void run() {
        ${cursor}
      }
    });

コードを試してみると、いくつかのsysoを削除できなかったことがあります。そこで私はsytというテンプレートを作りました。

System.out.println(${word_selection}${});//${todo}:remove${cursor}

コンパイルする前に、常にTODOをチェックし、System.outを再び削除することを決して忘れません。

strf -> String.format("msg", args) かなりシンプルですが、タイピングの手間が省けます。

String.format("${cursor}",)

現在のディスプレイからSWTカラーを取得します。

Display.getCurrent().getSystemColor(SWT.COLOR_${cursor})

syncexecでサラウンド

PlatformUI.getWorkbench().getDisplay().syncExec(new Runnable(){
    public void run(){
        ${line_selection}${cursor}
    }
});

シングルトン設計パターンを使用します。

/**
 * The shared instance.
 */
private static ${enclosing_type} instance = new ${enclosing_type}();

/**
 * Private constructor.
 */
private ${enclosing_type}() {
    super();
}

/**
 * Returns this shared instance.
 *
 * @returns The shared instance
 */
public static ${enclosing_type} getInstance() {
    return instance;
}

そして、equalsbuilder、hashcodebuilderの適応：

${:import(org.apache.commons.lang.builder.EqualsBuilder,org.apache.commons.lang.builder.HashCodeBuilder)}
@Override
public boolean equals(Object obj) {
    return EqualsBuilder.reflectionEquals(this, obj);
}

@Override
public int hashCode() {
    return HashCodeBuilder.reflectionHashCode(this);
}

ロガー宣言のテンプレートは素晴らしいです。

また、頻繁に使用するログレベルのlinfo、ldebug、lwarn、lerrorも作成します。

lerror：

logger.error(${word_selection}${});${cursor}

イベントのすべてを作成する

イベントはJavaで作成するのがちょっと面倒なので、これらのすべてのインターフェース、メソッド、および1つのイベントだけのために書くものなど、1つのイベントに必要なすべてのものを作成する単純なテンプレートを作成しました。

${:import(java.util.List, java.util.LinkedList, java.util.EventListener, java.util.EventObject)}

private final List<${eventname}Listener> ${eventname}Listeners = new LinkedList<${eventname}Listener>();

public final void add${eventname}Listener(${eventname}Listener listener)
{
    synchronized(${eventname}Listeners) {
        ${eventname}Listeners.add(listener);
    }
}

public final void remove${eventname}Listener(${eventname}Listener listener)
{
    synchronized(${eventname}Listeners) {
        ${eventname}Listeners.remove(listener);
    }
}

private void raise${eventname}Event(${eventname}Args args)
{
    synchronized(${eventname}Listeners) {
        for(${eventname}Listener listener : ${eventname}Listeners)
            listener.on${eventname}(args);
    }
}

public interface ${eventname}Listener extends EventListener
{
    public void on${eventname}(${eventname}Args args);
}

public class ${eventname}Args extends EventObject
{
    public ${eventname}Args(Object source${cursor})
    {
        super(source);
    }
}

あなたは、単一の共有イベントを持っている場合はEventObject、単にテンプレートによって挿入されたカスタマイズされたものを削除して、適切な部分を変更raise___()してon____()。

ジェネリックインターフェイスとジェネリッククラスを使用して、素敵で小さくエレガントなイベントメカニズムを作成しましたが、Javaがジェネリックを処理する方法が原因で機能しません。=（

編集：1）イベントの発生中にスレッドがリスナーを追加または削除する問題に遭遇しました。List使用中にIを加えて、変更することはできませんsynchronizedリスト自体にロック、リスナーのリストがアクセスまたは使用されているブロック。

テストメソッドを挿入する必要があります。

最近、このバージョンに似たバージョンを見て、非常に優れた開発者や友人とプログラミングを組み合わせていました。このリストに追加するとよいでしょう。

このテンプレートは、コードを構造化するためのガイドとして、コメントのビヘイビア駆動開発（BDD）パラダイムから「Given-When-Then」アプローチに従って、クラスに新しいテストメソッドを作成します。メソッド名は「should」で始まり、残りのダミーメソッド名「CheckThisAndThat」を、テストメソッドの責任の可能な限り適切な説明に置き換えることができます。名前を入力すると、TABはに直接移動するので、前提条件の入力を開始できます。// Given section

私はそれを3つの文字「tst」にマッピングし、「テストメソッドは指定した場合にテストする必要がある」という説明を付けています;）

私がそれを見たときと同じように、あなたがそれが役に立つことを願っています：

@Test
public void should${CheckThisAndThat}() {
    Assert.fail("Not yet implemented");
    // Given
    ${cursor}

    // When


    // Then

}${:import(org.junit.Test, org.junit.Assert)}

春の注射

私はこれがゲームの後半にあることを知っていますが、ここで私がクラスでSpring Injectionに使用するものを示します。

${:import(org.springframework.beans.factory.annotation.Autowired)}
private ${class_to_inject} ${var_name};

@Autowired
public void set${class_to_inject}(${class_to_inject} ${var_name}) {
  this.${var_name} = ${var_name};
}

public ${class_to_inject} get${class_to_inject}() {
  return this.${var_name};
}

以下は、インスタンス化できないクラスのコンストラクタです。

// Suppress default constructor for noninstantiability
@SuppressWarnings("unused")
private ${enclosing_type}() {
    throw new AssertionError();
}

これはカスタム例外用です：

/**
 * ${cursor}TODO Auto-generated Exception
 */
public class ${Name}Exception extends Exception {
    /**
     * TODO Auto-generated Default Serial Version UID
     */
    private static final long serialVersionUID = 1L;    

    /**
     * @see Exception#Exception()
     */
    public ${Name}Exception() {
        super();
    }

    /**
     * @see Exception#Exception(String) 
     */
    public ${Name}Exception(String message) {
        super(message);         
    }

    /**
     * @see Exception#Exception(Throwable)
     */
    public ${Name}Exception(Throwable cause) {
        super(cause);           
    }

    /**
     * @see Exception#Exception(String, Throwable)
     */
    public ${Name}Exception(String message, Throwable cause) {
        super(message, cause);
    }
}

私はこのように生成されたクラスのコメントが好きです：

/**
 * I... 
 * 
 * $Id$
 */

「I ...」は、クラスが何をするかを説明するよう開発者にすぐに勧めます。ドキュメント化されていないクラスの問題を改善しているようです。

そしてもちろん$ Id $は便利なCVSキーワードです。

これらのスニペットを何度も使用して、null値と空の文字列を探しました。

受け取った引数をチェックするためのメソッドの最初のコードとして、「引数テスト」テンプレートを使用します。

testNullArgument

if (${varName} == null) {
    throw new NullPointerException(
        "Illegal argument. The argument cannot be null: ${varName}");
}

会社またはプロジェクトの標準に合わせて例外メッセージを変更することができます。ただし、問題のある引数の名前を含むメッセージを表示することをお勧めします。それ以外の場合は、メソッドの呼び出し元がコードを調べて、問題の原因を理解する必要があります。（NullPointerExceptionメッセージのないA は、かなり無意味なメッセージ「null」の例外を生成します）。

testNullOrEmptyStringArgument

if (${varName} == null) {
    throw new NullPointerException(
        "Illegal argument. The argument cannot be null: ${varName}");
}
${varName} = ${varName}.trim();
if (${varName}.isEmpty()) {
    throw new IllegalArgumentException(
        "Illegal argument. The argument cannot be an empty string: ${varName}");
}

上記のnullチェックテンプレートを再利用して、このスニペットを実装し、空の文字列のみをチェックすることもできます。次に、これらの2つのテンプレートを使用して上記のコードを生成します。

ただし、上記のテンプレートには、in引数がfinalの場合、生成されたコードの一部を修正する必要があるという問題があります（${varName} = ${varName}.trim()失敗します）。

多くの最終引数を使用し、空の文字列をチェックしたいが、コードの一部としてそれらをトリムする必要がない場合は、代わりにこれを使用できます。

if (${varName} == null) {
    throw new NullPointerException(
        "Illegal argument. The argument cannot be null: ${varName}");
}
if (${varName}.trim().isEmpty()) {
    throw new IllegalArgumentException(
        "Illegal argument. The argument cannot be an empty string: ${varName}");
}

testNullFieldState

また、引数として送信されない変数をチェックするためのスニペットもいくつか作成しました（大きな違いは例外タイプで、現在はIllegalStateException代わりになっています）。

if (${varName} == null) {
    throw new IllegalStateException(
        "Illegal state. The variable or class field cannot be null: ${varName}");
}

testNullOrEmptyStringFieldState

if (${varName} == null) {
    throw new IllegalStateException(
        "Illegal state. The variable or class field cannot be null: ${varName}");
}
${varName} = ${varName}.trim();
if (${varName}.isEmpty()) {
    throw new IllegalStateException(
        "Illegal state. The variable or class field " +
            "cannot be an empty string: ${varName}");
}

testArgument

これは、変数をテストするための一般的なテンプレートです。これを正しく理解するのに数年かかりましたが、今では（もちろん上記のテンプレートと組み合わせて）たくさん使用しています。

if (!(${varName} ${testExpression})) {
    throw new IllegalArgumentException(
        "Illegal argument. The argument ${varName} (" + ${varName} + ") " +
        "did not pass the test: ${varName} ${testExpression}");
}

変数名または値を返す条件を入力し、その後にオペランド（ "=="、 "<"、 ">"など）と別の値または変数を続けます。テストが失敗した場合、結果のコードはIllegalArgumentExceptionをスローします。

式全体が "！（）"で囲まれている、やや複雑なif句の理由は、例外メッセージでテスト条件を再利用できるようにするためです。

おそらくそれは同僚を混乱させるでしょうが、彼らがコードを見る必要がある場合に限り、あなたがこれらの種類の例外をスローする場合には必要ないかもしれません...

配列の例を次に示します。

public void copy(String[] from, String[] to) {
    if (!(from.length == to.length)) {
        throw new IllegalArgumentException(
                "Illegal argument. The argument from.length (" +
                            from.length + ") " +
                "did not pass the test: from.length == to.length");
    }
}

テンプレートを呼び出し、「from.length」[TAB]「== to.length」と入力すると、この結果が得られます。

結果は、「ArrayIndexOutOfBoundsException」または類似のものよりもかなりおかしく、実際にユーザーに問題を理解する機会を与える可能性があります。

楽しい！

これをMessageFormatに使用します（Java 1.4を使用）。そうすれば、国際化を行うときに抽出するのが難しい連結がないことが確実になります。

国際化

String msg = "${message}";
Object[] params = {${params}};
MessageFormat.format(msg, params);

ロギングについても：

ログ

if(logger.isDebugEnabled()){
  String msg = "${message}"; //NLS-1
  Object[] params = {${params}};
  logger.debug(MessageFormat.format(msg, params));
}

私の好きな人は...

1：Javadoc。Springオブジェクトインジェクションメソッドであるメソッドに関するドキュメントを挿入します。

 Method to set the <code>I${enclosing_type}</code> implementation that this class will use.
* 
* @param ${enclosing_method_arguments}<code>I${enclosing_type}</code> instance 

2：デバッグウィンドウ。FileOutputStreamを作成し、バッファの内容をファイルに書き込みます。バッファーを過去の実行と比較したい場合（BeyondCompareを使用）、またはバッファーが大きすぎるため（inspectを介して）バッファーの内容を表示できない場合に使用します...

java.io.FileOutputStream fos = new java.io.FileOutputStream( new java.io.File("c:\\x.x"));
fos.write(buffer.toString().getBytes());
fos.flush();
fos.close();