Шукаю корисні шаблони коду Java Eclipse [закрито]

Ви можете створити різні шаблони коду Java в Eclipse через

Вікно> Налаштування> Java> Редактор> Шаблони

напр

sysout розширено до:

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

Ви можете активувати це, ввівши sysoutдаліCTRL+SPACE

Які корисні шаблони коду Java ви зараз використовуєте? Включіть назву та опис цього і чому це приголомшливо.

Я шукаю оригінальне / нове використання шаблону, а не вбудовану існуючу функцію.

• Створіть Log4J реєстратор
• Отримайте яскравий колір з дисплея
• Syncexec - Eclipse Framework
• Singleton Pattern / Enum Singleton Generation
• Файл читання
• Конст
• Трейсінг
• Формат рядка
• Огляд коду коментаря
• Формат рядків
• Спробуйте нарешті заблокувати
• Формат повідомлення i18n та журнал
• Рівнобудівник
• Hashcodebuilder
• Весна впорскування об'єкта
• Створіть 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);

Джерело .

ЮЛ

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

Деякі додаткові шаблони тут: Посилання I - Посилання II

Мені подобається цей:

файл читання

 ${: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 двічі.

Блокуйте вибір

замок - оточіть вибрані лінії за допомогою блокування спробуйте остаточно. Припустимо наявність змінної блокування.

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

${line_selection}Шаблони NB відображаються в меню 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};

Знущатися з методом недійсності, щоб кинути виняток:

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

Знущатися з методом недійсності, щоб щось зробити:

${: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});

Перевірте знущенний метод, викликаний рівно один раз:

${: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();

Також я використовую величезний шаблон, який створює тестовий клас. Ось укорочений фрагмент його, який всі бажаючі повинні налаштувати:

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}
}

Один з моїх коханих - це проповідь :

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

І трасування , оскільки я дуже використовую його для відстеження:

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

Я просто подумав про ще один і знайшов його через Інтернет в якийсь день, const :

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

Маленька порада щодо sysout - я люблю перейменовувати її на "sop". Ніщо інше в java libs не починається з "sop", тому ви можете швидко набрати "sop" і boom, він вставляється.

Викиньте IllegalArgumentException зі змінною в поточному обсязі (illarg):

throw new IllegalArgumentException(${var});

Краще

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

Нічого фантазії для виготовлення коду - але досить корисно для огляду коду

У мене є шаблон coderev low / med / high зробити наступне

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

А потім у вікні Завдання - покаже мені всі коментарі з перегляду коду, які я хочу піднести під час зустрічі.

Ще кілька шаблонів тут .

Включає:

• Створіть об’єкт дати з певної дати
• Створіть новий загальний ArrayList
• Налаштування журналу
• Журнал із заданим рівнем
• Створіть новий загальний HashMap
• Повторіть карту, роздрукуйте ключі та значення
• Розбирайте час за допомогою SimpleDateFormat
• Прочитайте файл за рядком
• Увійдіть і повторно скиньте спіймане вилучення
• Час виконання друку блоку коду
• Створіть періодичний таймер
• Напишіть рядок у файл

slf4j Лісозаготівля

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

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

Бін власності

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, чудовий спосіб налаштування реєстраторів, які потребують (або віддають перевагу) статичні посилання на клас, що вкладається, - це використання щойно введеного API MethodHandles для отримання класу виконання в статичному контексті.

Приклад фрагмента для 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 s. Тому я зробив собі шаблон під назвою 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})

Сурма з синцексеком

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;
}

І пристосування для рівнобудівника, хеш-кодекса:

${: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 для рівнів журналів, якими я частіше користуюся.

леррор:

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

Створіть усе для події

Оскільки події своєрідно болять у створенні Java - усі ці інтерфейси, методи та інше писати лише на одну подію - я створив простий шаблон для створення всього необхідного для 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час використання його неможливо змінити, тому я додав synchronizedблоки, де доступ до списку слухачів використовується або використовується, блокуючись у самому списку.

Вставити методи тестування слід, коли-коли

Нещодавно я побачив подібну версію до цієї, коли програмував пару з дуже хорошим розробником та другом, і, думаю, це може бути приємним доповненням до цього списку.

Цей шаблон створить новий метод тестування для класу, дотримуючись параметр « Подано - Коли - Тоді» з парадигми, розробленої поведінкою (BDD) на коментарі, як керівництво для структурування коду. Він почне ім'я методу з "слід" і дозволить замінити решту імені методу фіктивного методу "CheckThisAndThat" найкращим описом відповідальності методу тестування. Після заповнення імені TAB переведе вас прямо до // Given section, тому ви можете почати вводити свої попередні умови.

У мене це відображено на три букви "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$
 */

"Я ..." негайно спонукає розробника описати, що робить клас. Я, здається, вдосконалює проблему незадокументованих занять.

І звичайно, $ Id $ - корисне ключове слово CVS.

Я багато використовував ці фрагменти, шукав nullзначення та порожні рядки.

Я використовую шаблони "тест аргументів" як перший код у своїх методах для перевірки отриманих аргументів.

testNullArgument

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

Ви можете змінити повідомлення про виключення, щоб відповідати стандарту вашої компанії або проекту. Однак я рекомендую мати якесь повідомлення, яке містить ім'я аргументу-порушення. Інакше абоненту вашого методу доведеться шукати код, щоб зрозуміти, що пішло не так. (Повідомлення NullPointerExceptionбез повідомлення створює виняток із досить безглуздим повідомленням "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}");
}

Ви також можете повторно використовувати шаблон перевірки нуля зверху та застосувати цей фрагмент, щоб перевірити лише чи порожні рядки. Потім ви використовуєте ці два шаблони для створення вищевказаного коду.

У наведеному вище шаблоні є проблема, що якщо аргумент остаточний, вам доведеться деякі змінити створений код ( ${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}");
}

аргумент тесту

Це загальний шаблон для тестування змінної. Мені знадобилося кілька років, щоб справді навчитися цінувати цей, зараз я його багато використовую (у поєднанні з вищевказаними шаблонами, звичайно!)

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

Ви вводите ім'я змінної або умову, яка повертає значення, після чого операнд ("==", "<", ">" тощо) та інше значення або змінну, і якщо тест не вдасться, результат отриманий код кине IllegalArgumentException.

Причиною дещо складного, якщо пункт із усім виразом, загорнутим у "! ()", - це зробити можливим повторне використання тестової умови у повідомленні про виключення.

Можливо, це збентежить колегу, але лише в тому випадку, якщо їм доведеться подивитися на код, який, можливо, не доведеться, якщо ви кинете такі винятки ...

Ось приклад з масивами:

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). Таким чином я впевнений, що у мене немає конкатенацій, які важко витягти, коли робиш інтернаціоналізацію

i18n

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) або якщо ви не можете переглянути вміст буфера (через перевірку), оскільки його занадто великий ...

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