Java: Линтер
Теперь, когда мы уже научились писать простые программы, можно немного поговорить о том, как их писать.
Код программы следует оформлять определенным образом, чтобы он был достаточно понятным и простым в поддержке.
Специальные наборы правил — стандарты — описывают различные аспекты написания кода. Конкретно в Java самым распространенным стандартом является стандарт от Sun.
В любом языке программирования существуют утилиты — так называемые линтеры. Они проверяют код на соответствие стандартам. В Java это checkstyle. Взгляните на пример:
System.out.println( "Hello, World!" ); System.out.println("I'm a developer!") ;Линтер будет ругаться на нарушение сразу в нескольких местах:
- '(' is followed by whitespace. [ParenPad]
- ')' is preceded with whitespace. [ParenPad]
- ';' is preceded with whitespace. [NoWhitespaceBefore]
- Only one statement per line allowed. [OneStatementPerLine]
Проанализируем данные ошибки:
- Правило ParenPad, указанное в квадратных скобках, требует отсутствия пробелов после открывающейся и перед закрывающейся круглыми скобками
- Правило NoWhitespaceBefore указывает, что перед точкой с запятой не нужно устанавливать лишний пробел
- Каждую новую инструкцию принято записывать с новой строки. На это указывает правило OneStatementPerLine
Соблюдение данных правил не влияет на результат, но помогает писать код понятнее и проще для восприятия.
Код с учетом этих правил выглядит так:
System.out.println("Hello, World!");
System.out.println("I'm a developer!");Теперь линтер ругаться не будет. Какой мы делаем вывод? Линтер помогает писать код, который будет легче читать и анализировать.
Линтер только сообщает о нарушении. Для исправления кода используют форматтеры, программы, которые приводят код к стандарту сами.
В Java форматирование подключают плагином spotless. Сам формат задаёт google-java-format, стандарт оформления от Google. Одна команда, и весь код проекта выглядит единообразно, поэтому спорить о расстановке пробелов и переносов в команде не приходится.
Помните, что наличие линтера не отменяет самостоятельного анализа и упрощения чтения кода. В проектах на Хекслете и в реальной разработке проверка стиля встроена в сборку, и код с нарушениями до ревью не доезжает.
Задание
Выведите на экран результат следующего вычисления: «разница между суммой пяти и двух и произведением трёх и семи». Сравните получившийся результат с решением учителя с точки зрения оформления кода.
Java: Линтер
Теперь, когда мы уже научились писать простые программы, можно немного поговорить о том, как их писать.
Код программы следует оформлять определенным образом, чтобы он был достаточно понятным и простым в поддержке.
Специальные наборы правил — стандарты — описывают различные аспекты написания кода. Конкретно в Java самым распространенным стандартом является стандарт от Sun.
В любом языке программирования существуют утилиты — так называемые линтеры. Они проверяют код на соответствие стандартам. В Java это checkstyle. Взгляните на пример:
System.out.println( "Hello, World!" ); System.out.println("I'm a developer!") ;Линтер будет ругаться на нарушение сразу в нескольких местах:
- '(' is followed by whitespace. [ParenPad]
- ')' is preceded with whitespace. [ParenPad]
- ';' is preceded with whitespace. [NoWhitespaceBefore]
- Only one statement per line allowed. [OneStatementPerLine]
Проанализируем данные ошибки:
- Правило ParenPad, указанное в квадратных скобках, требует отсутствия пробелов после открывающейся и перед закрывающейся круглыми скобками
- Правило NoWhitespaceBefore указывает, что перед точкой с запятой не нужно устанавливать лишний пробел
- Каждую новую инструкцию принято записывать с новой строки. На это указывает правило OneStatementPerLine
Соблюдение данных правил не влияет на результат, но помогает писать код понятнее и проще для восприятия.
Код с учетом этих правил выглядит так:
System.out.println("Hello, World!");
System.out.println("I'm a developer!");Теперь линтер ругаться не будет. Какой мы делаем вывод? Линтер помогает писать код, который будет легче читать и анализировать.
Линтер только сообщает о нарушении. Для исправления кода используют форматтеры, программы, которые приводят код к стандарту сами.
В Java форматирование подключают плагином spotless. Сам формат задаёт google-java-format, стандарт оформления от Google. Одна команда, и весь код проекта выглядит единообразно, поэтому спорить о расстановке пробелов и переносов в команде не приходится.
Помните, что наличие линтера не отменяет самостоятельного анализа и упрощения чтения кода. В проектах на Хекслете и в реальной разработке проверка стиля встроена в сборку, и код с нарушениями до ревью не доезжает.
Задание
Выведите на экран результат следующего вычисления: «разница между суммой пяти и двух и произведением трёх и семи». Сравните получившийся результат с решением учителя с точки зрения оформления кода.
Ваше упражнение проверяется по этим тестам
import static org.assertj.core.api.Assertions.assertThat;
import java.io.ByteArrayOutputStream;
import java.io.FileDescriptor;
import java.io.FileOutputStream;
import java.io.PrintStream;
class AppTest {
public static void main(String[] args) {
final var expected = "-14";
ByteArrayOutputStream out = new ByteArrayOutputStream();
System.setOut(new PrintStream(out));
App.main(null);
final var actual = out.toString().trim();
System.setOut(new PrintStream(new FileOutputStream(FileDescriptor.out)));
System.out.println(actual);
assertThat(actual).isEqualTo(expected);
}
}Решение учителя откроется через:
20:00
