Suppresswarnings java что это

Пользовательские аннотации

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

1. Уменьшение дублирования кода.
2. Автоматизация генерации бойлерплейт кода.
3. Отлов ошибок во время компиляции, например, потенциальные Null Pointer Exception.
4. Настройка поведения в рантайме на основе наличия аннотации.

Для примера рассмотрим аннотацию @Company :

@Company < name="ABC" city="XYZ" >public class CustomAnnotatedEmployee

При создании экземпляров класса CustomAnnotatedEmployee все экземпляры будут содержать одно и то же название компании (name) и города (city) — больше не нужно добавлять эту информацию в конструктор.

Создать пользовательскую аннотацию можно с помощью ключевого слова @interface :

public @interface Company

Чтобы указать информацию об области действия аннотации и о типах элементов, к которым она может быть применена, используются мета-аннотации.

Например, чтобы указать, что аннотация применяется только к классам, используется аннотация @Target(ElementType.TYPE) . А мета-аннотация @Retention(RetentionPolicy.RUNTIME) указывает, что аннотация должна быть доступна в рантайме.

С мета-аннотациями наша аннотация @Company выглядит следующим образом:

@Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) public @interface Company

Далее добавим атрибуты в нашу аннотацию: имя ( name ) и город ( city ). Добавляем их, как показано ниже:

@Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) public @interface Company

Создадим класс CustomAnnotatedEmployee и применим к нему аннотацию @Company :

@Company public class CustomAnnotatedEmployee < private int id; private String name; public CustomAnnotatedEmployee(int id, String name) < this.id = id; this.name = name; >public void getEmployeeDetails() < System.out.println("Employee Id: " + id); System.out.println("Employee Name: " + name); >>

Прочитать аннотацию @Company в рантайме можно следующим образом:

import java.lang.annotation.Annotation; public class TestCustomAnnotatedEmployee < public static void main(String[] args) < CustomAnnotatedEmployee employee = new CustomAnnotatedEmployee(1, "John Doe"); employee.getEmployeeDetails(); Annotation companyAnnotation = employee .getClass() .getAnnotation(Company.class); Company company = (Company)companyAnnotation; System.out.println("Company Name: " + company.name()); System.out.println("Company City: " + company.city()); >>

Результат будет следующий:

Employee Id: 1 Employee Name: John Doe Company Name: ABC Company City: XYZ

Анализируя аннотацию в рантайме, мы можем получить доступ к некоторой общей информации обо всех сотрудниках и избежать дублирования кода.

Мета-аннотации

Мета-аннотации — это аннотации, применяемые к другим аннотациям для предоставления информации об аннотации компилятору или среде выполнения.

Мета-аннотации могут ответить на следующие вопросы об аннотации:

1. Может ли аннотация наследоваться дочерними классами?
2. Должна ли аннотация отображаться в документации?
3. Можно ли применить аннотацию несколько раз к одному и тому же элементу?
4. К какому типу элементов можно применить аннотацию: к классу, методу, полю и т.д.?
5. Обрабатывается ли аннотация во время компиляции или в рантайме?

@Inherited

По умолчанию аннотация не наследуется от родительского класса к дочернему. Мета-аннотация @Inherited позволяет ей наследоваться:

@Inherited @Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) public @interface Company < String name() default "ABC"; String city() default "XYZ"; >@Company public class CustomAnnotatedEmployee < private int id; private String name; public CustomAnnotatedEmployee(int id, String name) < this.id = id; this.name = name; >public void getEmployeeDetails() < System.out.println("Employee Id: " + id); System.out.println("Employee Name: " + name); >> public class CustomAnnotatedManager extends CustomAnnotatedEmployee < public CustomAnnotatedManager(int id, String name) < super(id, name); >>

Поскольку CustomAnnotatedEmployee аннотирован @Company , а CustomAnnotatedManager наследуется от него, то нет необходимости ставить аннотацию на класс CustomAnnotatedManager .

Давайте проверим это.

public class TestCustomAnnotatedManager < public static void main(String[] args) < CustomAnnotatedManager manager = new CustomAnnotatedManager(1, "John Doe"); manager.getEmployeeDetails(); Annotation companyAnnotation = manager .getClass() .getAnnotation(Company.class); Company company = (Company)companyAnnotation; System.out.println("Company Name: " + company.name()); System.out.println("Company City: " + company.city()); >>

Аннотация @Company доступна, хотя мы не указывали ее явно для класса Manager .

@Documented

@Documented указывает, что аннотация должна присутствовать в JavaDoc.

По умолчанию информация об аннотациях не отображается в JavaDoc-документации, но если использовать @Documented, она появится:

@Inherited @Documented @Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) public @interface Company

@Repeatable

@Repeatable позволяет использовать аннотацию несколько раз на одном методе, классе или поле. Для использования @Repeatable — аннотации необходимо создать аннотацию-контейнер, которая хранит значение в виде массива исходных аннотаций:>

@Target(ElementType.TYPE) @Repeatable(RepeatableCompanies.class) @Retention(RetentionPolicy.RUNTIME) public @interface RepeatableCompany

@Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) public @interface RepeatableCompanies < RepeatableCompany[] value() default<>; >

Использовать аннотацию можно следующим образом:

@RepeatableCompany @RepeatableCompany(name = "Name_2", city = "City_2") public class RepeatedAnnotatedEmployee

public class TestRepeatedAnnotation < public static void main(String[] args) < RepeatableCompany[] repeatableCompanies = RepeatedAnnotatedEmployee.class .getAnnotationsByType(RepeatableCompany.class); for (RepeatableCompany repeatableCompany : repeatableCompanies) < System.out.println("Name: " + repeatableCompany.name()); System.out.println("City: " + repeatableCompany.city()); >> >

Получим следующий результат, отображающий значение нескольких аннотаций @RepeatableCompany :

Name: Name_1 City: City_1 Name: Name_2 City: City_2

@Target

@Target определяет типы элементов, к которым может применяться аннотация. Например, в приведенном выше примере аннотация @Company была определена как TYPE, и поэтому может быть применена только к классам.

Давайте попробуем применить аннотацию @Company к методу:

@Company public class Employee < @Company public void getEmployeeStatus()< System.out.println("This is the Base Employee class"); >>

В этом случае мы получим ошибку компилятора: @Company not applicable to method .

Существуют следующие типы целей, названия которых говорят сами за себя:

• ElementType.ANNOTATION_TYPE
• ElementType.CONSTRUCTOR
• ElementType.FIELD
• ElementType.LOCAL_VARIABLE
• ElementType.METHOD
• ElementType.PACKAGE
• ElementType.PARAMETER
• ElementType.TYPE

@Retention

@Retention указывает, когда аннотация будет доступна:

• SOURCE — аннотация доступна в исходном коде и удаляется после компиляции.
• CLASS — аннотация сохраняется в class-файле во время компиляции, но недоступна при выполнении программы.
• RUNTIME — аннотация доступна в рантайме.

Если аннотация нужна только для проверки ошибок во время компиляции, как это делает @Override , мы используем SOURCE. Если аннотация нужна для обеспечения функциональности в рантайме, например, @Test в JUnit, то используем RUNTIME. Давайте поэкспериментируем с разными значениями RetentionPolicy :

@Target(ElementType.TYPE) @Retention(RetentionPolicy.CLASS) public @interface ClassRetention < >@Target(ElementType.TYPE) @Retention(RetentionPolicy.SOURCE) public @interface SourceRetention < >@Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) public @interface RuntimeRetention

Создадим класс, который использует все три аннотации:

@SourceRetention @RuntimeRetention @ClassRetention public class EmployeeRetentionAnnotation

Для проверки доступности аннотаций запустите следующий код:

public class RetentionTest < public static void main(String[] args) < SourceRetention[] sourceRetention = new EmployeeRetentionAnnotation() .getClass() .getAnnotationsByType(SourceRetention.class); System.out.println("Source Retentions at runtime: " + sourceRetention.length); RuntimeRetention[] runtimeRetention = new EmployeeRetentionAnnotation() .getClass() .getAnnotationsByType(RuntimeRetention.class); System.out.println("Runtime Retentions at runtime: " + runtimeRetention.length); ClassRetention[] classRetention = new EmployeeRetentionAnnotation() .getClass() .getAnnotationsByType(ClassRetention.class); System.out.println("Class Retentions at runtime: " + classRetention.length); >>

Результат будет следующим:

Source Retentions at runtime: 0 Runtime Retentions at runtime: 1 Class Retentions at runtime: 0

Итак, мы убедились, что в рантайме доступна только RUNTIME-аннотация.

Классификация аннотаций

Аннотации можно классифицировать по количеству передаваемых в них параметров: без параметров, с одним параметром и с несколькими параметрами.

Маркерные аннотации

Маркерные аннотации не содержат никаких членов или данных. Для определения наличия аннотации можно использовать метод isAnnotationPresent() .

Например, если бы у нашей компании было несколько клиентов с разными способами передачи данных, мы могли бы аннотировать класс аннотацией, указывающей способ передачи данных:

@Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) public @interface CSV

Класс Client может использовать аннотацию следующим образом:

@CSV public class XYZClient

Обработать аннотацию можно следующим образом:

public class TestMarkerAnnotation < public static void main(String[] args) < XYZClient client = new XYZClient(); Class clientClass = client.getClass(); if (clientClass.isAnnotationPresent(CSV.class))< System.out.println("Write client data to CSV."); >else < System.out.println("Write client data to Excel file."); >> >

На основании присутствия аннотации @CSV , мы можем решить, куда записать информацию — в CSV или в файл Excel. Приведенная выше программа выдаст следующий результат:

Write client data to CSV.

Аннотации с одним значением

Аннотации с одним значением содержат только один атрибут, который принято называть value.

Давайте создадим аннотацию SingleValueAnnotationCompany с одним атрибутом value :

@Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) public @interface SingleValueAnnotationCompany

Создайте класс, использующий аннотацию:

@SingleValueAnnotationCompany("XYZ") public class SingleValueAnnotatedEmployee < private int id; private String name; public SingleValueAnnotatedEmployee(int id, String name) < this.id = id; this.name = name; >public void getEmployeeDetails() < System.out.println("Employee Id: " + id); System.out.println("Employee Name: " + name); >>

Запустите следующий пример:

public class TestSingleValueAnnotatedEmployee < public static void main(String[] args) < SingleValueAnnotatedEmployee employee = new SingleValueAnnotatedEmployee(1, "John Doe"); employee.getEmployeeDetails(); Annotation companyAnnotation = employee .getClass() .getAnnotation(SingleValueAnnotationCompany.class); SingleValueAnnotationCompany company = (SingleValueAnnotationCompany)companyAnnotation; System.out.println("Company Name: " + company.value()); >>

Переданное значение "XYZ" переопределяет значение атрибута аннотации по умолчанию. Результат выглядит следующим образом:

Employee Id: 1 Employee Name: John Doe Company Name: XYZ

Полные аннотации

Они состоят из нескольких пар "имя-значение". Например, Company(name = "ABC", city = "XYZ") . Рассмотрим наш исходный пример Company:

@Target(ElementType.TYPE) @Retention(RetentionPolicy.RUNTIME) public @interface Company

Давайте создадим класс MultiValueAnnotatedEmployee со значением параметров, как показано ниже. Значения по умолчанию будут перезаписаны.

@Company(name = "AAA", city = "ZZZ") public class MultiValueAnnotatedEmployee

Запустите следующий пример:

public class TestMultiValueAnnotatedEmployee < public static void main(String[] args) < MultiValueAnnotatedEmployee employee = new MultiValueAnnotatedEmployee(); Annotation companyAnnotation = employee.getClass().getAnnotation(Company.class); Company company = (Company)companyAnnotation; System.out.println("Company Name: " + company.name()); System.out.println("Company City: " + company.city()); >>

Company Name: AAA Company City: ZZZ

Практический пример

В качестве практического примера обработки аннотаций напишем простой аналог аннотации @Test из JUnit. Пометив методы аннотацией @Test , мы сможем определить в рантайме, какие методы тестового класса нужно запускать как тесты.

Сначала создадим маркерную аннотацию для методов-тестов:

@Retention(RetentionPolicy.RUNTIME) @Target(ElementType.METHOD) public @interface Test

Далее создадим класс AnnotatedMethods , в котором применим аннотацию @Test к методу test1() . Это позволит выполнить метод в рантайме. У метода test2() аннотации нет и он не должен выполняться.

public class AnnotatedMethods < @Test public void test1() < System.out.println("This is the first test"); >public void test2() < System.out.println("This is the second test"); >>

Теперь напишем код для запуска тестов из класса AnnotatedMethods :

import java.lang.annotation.Annotation; import java.lang.reflect.Method; public class TestAnnotatedMethods < public static void main(String[] args) throws Exception < ClassannotatedMethodsClass = AnnotatedMethods.class; for (Method method : annotatedMethodsClass.getDeclaredMethods()) < Annotation annotation = method.getAnnotation(Test.class); Test test = (Test) annotation; // If the annotation is not null if (test != null) < try < method.invoke(annotatedMethodsClass .getDeclaredConstructor() .newInstance()); >catch (Throwable ex) < System.out.println(ex.getCause()); >> > > >

Через метод getDeclaredMethods() мы получаем методы класса AnnotatedMethods . Затем перебираем методы и проверяем, аннотирован ли метод аннотацией @Test . Наконец, выполняем вызов методов, которые были аннотированы с помощью @Test .

В результате метод test1() выполнится, поскольку он аннотирован @Test , а test2() нет, так как он без аннотации @Test .

This is the first test

Заключение

Мы сделали обзор основных стандартных аннотаций и рассмотрели, как создавать и обрабатывать свои аннотации.

Возможностей по использованию аннотаций гораздо больше, чем мы рассмотрели. Например, можно автоматически генерировать код для паттерна Builder. Шаблон проектирования Builder (строитель) используется как альтернатива конструкторам, когда в конструкторы передается много параметров или есть необходимость в нескольких конструкторах с необязательными параметрами. При большом количестве таких классов возможность генерации кода обработчиком аннотаций сэкономит много времени и поможет избежать дублирования кода.

Примеры кода вы можете найти на GitHub.

Всех желающих приглашаем на Demo-занятие «Объектно-ориентированное и функциональное программирование». На вебинаре поговорим о стилях программирования и необходимости каждого из них. Разберём основные принципы объектно-ориентированного стиля (Инкапсуляция, Наследование, Полиморфизм), а также возможности функционального стиля, которые предоставляет язык Java. Регистрация для всех желающих по ссылке.

• java
• Аннотации в Java
• ООП
• функциональное программирование

• Блог компании OTUS
• Java

Аннотации. Как пользоваться

Как ты уже, наверное, знаешь – аннотации – это такие специальные слова, которые можно размещать рядом с классами, полями, методами и переменными.

— Ага. Очень часто их встречаю.

— Иногда их называют еще метаданными. Основная их задача – хранить некоторую дополнительную информацию о методах, полях и классах.

— А для кого они ее хранят?

— Это очень хороший вопрос.

Раз эти аннотации пишут, значит, они кому-то нужны.

Аннотации позволяют хранить дополнительную информацию о коде и элементах программы, но формально не являются частью кода.

Аннотации можно использовать для генерации XML, определения, устарел метод или нет, отслеживания ошибок и т.п.

Пример аннотаций в коде:

@CatInfo(manager=Catmanager.class, unique=true) class Cat < @Name("Murka") private String name; @SuppressWarnings(value = "unchecked") void getUniqueCatName() < >>

Как ты видишь, в аннотациях можно хранить данные.

Если аннотация имеет только одно поле value , то его можно опускать:

@SuppressWarnings("unchecked") void getUniqueCatName()

Если параметров в скобках нет, скобки тоже можно не писать:

@Override void getUniqueCatName()

Создать свою аннотацию очень легко. Объявление аннотации – практически идентично объявлению интерфейса.

@interface CatManager 

Есть всего пара отличий.

Во-первых, перед словом interface ставится символ «@».

Во-вторых, аннотация может содержать значения по умолчанию. Для этого используется слово default. См. пример выше. Такие параметры являются необязательными и их можно опускать при добавлении аннотаций.

— Ага. Все оказалось проще, чем я думал. А то я уже шарахался от них, как Рободьявол от святой воды. Неприятно, когда в коде куча всяких штук, которые до конца не понимаешь.

— О, хорошо, что напомнил, хочу еще рассказать об аннотациях, используемых компилятором.

Таких аннотаций всего 3. Пока три.

@Deprecated.

Класс или метод можно пометить аннотацией @Deprecated. Тогда компилятор будет выдавать предупреждение (предупреждение — это не ошибка), а Intellij IDEA будет отображать этот метод как перечеркнутый. Примерно так:

Date date = new Date(); int year = date.getYear();

@Override.

При переопределении метода, хорошим тоном считается добавить ему аннотацию @Override.

— А для чего? Вроде же IDEA и так показывает, переопределен метод или нет?

— Во-первых, то IDEA, а то синтаксис Java.

А во-вторых, гипотетически может быть ситуация, когда метод базового класса переименуют, а метод наследника – нет. И программа будет работать неправильно, но никто этого не заметит. Для предотвращения таких ситуаций и была придумана эта аннотация:

@Override void getUniqueCatName()

@SuppressWarnings.

— Иногда компилятор выводит очень много предупреждений. Или мы знаем о «проблемах» и сознательно пошли на такое использование. С помощью этой аннотации можно скрыть часть из них.

С помощью аннотации @SuppressWarnings , программист может сказать компилятору: не нужно показывать предупреждения, так задумано, это не ошибка. Пример:

@SuppressWarnings("unchecked") void getUniqueCatName()

— Что-то я немного устал, пойду, промочу горло. Давай продолжим после перерыва, ок?

Комментарии (26)
ЧТОБЫ ПОСМОТРЕТЬ ВСЕ КОММЕНТАРИИ ИЛИ ОСТАВИТЬ КОММЕНТАРИЙ,
ПЕРЕЙДИТЕ В ПОЛНУЮ ВЕРСИЮ
overbf bf Уровень 40
10 ноября 2023

Вернулся сюда, что бы оставить это: https://javarush.com/groups/posts/1896-java-annotacii-chto-ehto-i-kak-ehtim-poljhzovatjhsja а то дальше вообще ничего не понятно.

Ra Уровень 51 Student
28 июля 2023
Когда пишете аннотацию, нажимайте Ctrl+P. И вообще всегда, когда нужны параметры метода)
Anonymous #3091828 Уровень 51
1 декабря 2022
Чет комментов становится оч мало, где люди подевались.
Рогов Игорь Уровень 17
31 мая 2022
не раскрыта цель аннотаций и их прям такая необходимость
Valua Sinicyn Уровень 41
26 февраля 2021

Тема маркеров аннотаций не раскрыта. Маркеры @SuppressWarnings: • all - отключение всех предупреждений; • boxing - отключение предупреждений, связанных с приведением к классам и простым типам; • cast - отключение предупреждений, связанных с преобразованием типов; • dep-ann - отключение предупреждений, связанных с устаревшими аннотациями; • deprecation - отключение предупреждений, связанных с устареванием; • fallthrough - отключение предупреждений, связанных с отсутствующими точками прерывания в операторах выбора; • finally - отключение предупреждений, связанных с окончательными блокировками, не возвращающими управление; • hiding - отключение предупреждений, связанных с локальными объектами, скрывающими переменные; • incomplete-switch - отключение предупреждений, связанных с недостающими элементами в операторах выбора (enum case); • javadoc - отключение предупреждений, связанных с предупреждениями javadoc; • nls отключение предупреждений, связанных с литеральными строками, не являющимися nls; • null - отключение предупреждений, связанных с анализом null; • rawtypes - отключение предупреждений, связанных с использованием непараметризованных типов; • resource - отключение предупреждений, связанных с использованием ресурсов типа Closeable; • restriction - отключение предупреждений, связанных с использованием нерекомендованных или запрещенных ресурсов; • serial - отключение предупреждений, связанных с недостающим полем serialVersionUID в классе, допускающем сериализацию; • static-access - отключение предупреждений, связанных с некорректными операциями статического доступа; • static-method - отключение предупреждений, связанных с методами, которые могут быть определены с модификатором static; • super - отключение предупреждений, связанных с переопределением метода без вызова базового метода; • synthetic-access - отключение предупреждений, связанных с неоптимизированным доступом из внутренних классов; • sync-override - отключение предупреждений из

ram0973 Уровень 41
12 января 2021

Небольшой бесплатный курс по Спрингу. Курс простой, понятный и демонстрирует аннотации, а также REST, SQL, HTTP, JSON. Самое время пройти за несколько вечеров. Интересно, что в IDEA есть и генератор HTTP-запросов, и SQL-консоль.Также официальный туториал , сложнее

Pavlo Buidenkov Уровень 41
30 мая 2020

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