Элегантное кодирование SpringBoot: благословение Ломбока

Java задняя часть Elasticsearch Project Lombok
Элегантное кодирование SpringBoot: благословение Ломбока

Обзор

Lombok помогает упростить и устранить часть обязательного, но раздутого кода Java, предоставляя простую форму синтаксических аннотаций. Типичным является упрощение объектов POJO (например, автоматическое создание для нас сеттеров и геттеров и т. д.), с благословения Ломбока разработчики могут избежать множества повторяющихся и раздутых операций,Значительно улучшите отношение сигнал-шум кода Java, так что мы должны попробовать и подать заявку!

Примечание:Эта статья была впервые опубликована на моем официальном аккаунтеCodeSheep,МожетНажмитеилисканированиеследующеебудь остороженЗаходи подписывайся ↓ ↓ ↓

CodeSheep · 程序羊

Конфигурация в IntelliJ IDEA

Метод 1: настроить непосредственно в интерфейсе идеи

  • Сначала войдите в интерфейс плагинов:

进入Plugins界面

  • Затем найдите и установите плагин Lombok:

安装Lombok插件

  • Наконец, не забудьте включить параметр «Включить» процессоров аннотаций:

Enable Annotation Processors

После завершения вышеуказанной установки вам необходимо перезапустить IDEA, чтобы изменения вступили в силу!

Способ 2. Вручную загрузите плагин Lombok и установите его.

Иногда из-за сетевых причин вышеприведенный метод не удается установить таким образом, поэтому вы можете загружать только и установить вручную

  • Загрузите плагины ломбока: https://github.com/mplushnikov/lombok-intellij-plugin/релизы

  • Плагины -> Установите плагин с диска ... Выберите загруженную установку ZIP пакета

选择lombok的zip包来安装

  • Просто перезапустите идею

重启IDEA生效

После настройки в IDE вам нужно добавить следующую зависимость lombok в pom.xml для использования

<dependency>
	<groupId>org.projectlombok</groupId>
	<artifactId>lombok</artifactId>
	<version>1.16.16</version>
</dependency>

Основные аннотации Ломбока

  • @Getter and @Setter/ Автоматически предоставлять методы Set и Get для свойств
  • @ToString/ Роль этой аннотации заключается в автоматической генерации метода toString() для класса
  • @EqualsAndHashCode/ Поле Object генерируется автоматически, реализуя equals и hashCode
  • @AllArgsConstructor, @RequiredArgsConstructor and @NoArgsConstructor/ Как следует из названия, конструктор, который автоматически генерирует соответствующие параметры для класса
  • @Log, @Log4j, @Log4j2, @Slf4j, @XSlf4j, @CommonsLog, @JBossLog/ Автоматически добавить соответствующую поддержку журнала для класса
  • @Data/ Автоматически добавлять @ToString, @EqualsAndHashCode, @Getter для всех полей, @Setter для неконечных полей и @RequiredArgsConstructor, что по сути эквивалентно комбинированному эффекту нескольких аннотаций
  • @NonNull/ автоматически помогает нам избегать нулевых указателей. Аннотация, воздействующая на параметры метода для автоматической генерации проверок нулевых параметров
  • @Cleanup/ Автоматически вызывать для нас метод close(). Воздействуя на локальные переменные, когда область действия заканчивается, автоматически вызывается метод close для освобождения ресурсов.

Лембок ниже на наиболее часто используемых@Dataи@LogАннотация к кодовому бою!

Используйте аннотацию @Data

Официальный сайт объясняет аннотацию @Data следующим образом:

All together now: A shortcut for @ToString, @EqualsAndHashCode, @Getter on all fields, @Setter on all non-final fields, and @RequiredArgsConstructor!

Разобраться несложно, это можно рассматривать как интеграцию нескольких аннотаций Ломбока, так что пользоваться очень удобно!

  • Давайте сначала создадим объект POJO UserLombok, общий способ написания выглядит следующим образом:
public class UserLombok {
  private final String name;
  private int age;
  private double score;
  private String[] tags;
  
  public UserLombok(String name) {
    this.name = name;
  }
  
  public String getName() {
    return this.name;
  }
  
  void setAge(int age) {
    this.age = age;
  }
  
  public int getAge() {
    return this.age;
  }
  
  public void setScore(double score) {
    this.score = score;
  }
  
  public double getScore() {
    return this.score;
  }
  
  public String[] getTags() {
    return this.tags;
  }
  
  public void setTags(String[] tags) {
    this.tags = tags;
  }
  
  @Override public String toString() {
    return "DataExample(" + this.getName() + ", " + this.getAge() + ", " + this.getScore() + ", " + Arrays.deepToString(this.getTags()) + “)”;
  }
  
  protected boolean canEqual(Object other) {
    return other instanceof DataExample;
  }
  
  @Override public boolean equals(Object o) {
    if (o == this) return true;
    if (!(o instanceof DataExample)) return false;
    DataExample other = (DataExample) o;
    if (!other.canEqual((Object)this)) return false;
    if (this.getName() == null ? other.getName() != null : !this.getName().equals(other.getName())) return false;
    if (this.getAge() != other.getAge()) return false;
    if (Double.compare(this.getScore(), other.getScore()) != 0) return false;
    if (!Arrays.deepEquals(this.getTags(), other.getTags())) return false;
    return true;
  }
  
  @Override public int hashCode() {
    final int PRIME = 59;
    int result = 1;
    final long temp1 = Double.doubleToLongBits(this.getScore());
    result = (result*PRIME) + (this.getName() == null ? 43 : this.getName().hashCode());
    result = (result*PRIME) + this.getAge();
    result = (result*PRIME) + (int)(temp1 ^ (temp1 >>> 32));
    result = (result*PRIME) + Arrays.deepHashCode(this.getTags());
    return result;
  }
}
  • После благословения Ломбока написание можно упростить следующим образом:
@Data
public class UserLombok {
    private final String name;
    private int age;
    private double score;
    private String[] tags;
}

Как используется в IDEA, Lombok автоматически отмечает завершение, как показано ниже:

Lombok注解自动补全

  • Давайте напишем тестовый код POJO
    public static void main( String[] args ) {
        UserLombok userLombok = new UserLombok("hansonwang99”);
        userLombok.setAge(18);
        String[] array = new String[]{"apple","juice”};
        userLombok.setTags( array );
        userLombok.setScore( 99.0 );
        System.out.println(userLombok);
    }

На рисунке ниже видно, что IDEA по-прежнему может автоматически завершать код, автоматически сгенерированный для нас Lombok:

自动生成的代码

  • печать результата

Поскольку Lombok автоматически сгенерировал для нас метод toString, результат печати объекта будет следующим:

UserLombok(name=hansonwang99, age=18, score=99.0, tags=[apple, juice])

Аннотация @Log в действии

В моей статьеПрактика ведения журнала Spring BootВ этой статье мы используем Log4j2 в качестве объекта журнала, который записывается следующим образом:

@RestController
@RequestMapping("/testlogging”)
public class LoggingTestController {

    private final Logger logger = LogManager.getLogger(this.getClass());

    @GetMapping("/hello”)
    public String hello() {
        for(int i=0;i<10_0000;i++){
            logger.info("info execute index method”);
            logger.warn("warn execute index method”);
            logger.error("error execute index method”);

        }

        return "My First SpringBoot Application”;
    }
}

После перехода на Lombok метод записи становится более лаконичным, нам нужно только ввести соответствующую аннотацию @Log для завершения генерации объекта журнала:

@RestController
@RequestMapping("/testloggingwithlombok”)
@Log4j2
public class LoggingTestControllerLombok {

    @GetMapping("/hello”)
    public String hello() {
        for(int i=0;i<10_0000;i++){
            log.info("info execute index method”);
            log.warn("warn execute index method”);
            log.error("error execute index method”);

        }

        return "My First SpringBoot Application”;
    }
}

Как же не все так изящно!

постскриптум

Дополнительные статьи автора о SpringBt находятся здесь:

Если вам интересно, вы также можете уделить время прочтению некоторых статей автора о контейнеризации и микросервисах:

CodeSheep · 程序羊

Категории