Проверьте качество кода

Сегодня я изучил хороший инструмент для определения качества кода проекта и установил его в свою IDE. Эта практика не имеет значения, она по-прежнему очень хороша. Позже я проверил документацию и обнаружил, что этот инструмент можно использовать не только в IDE, но он по-прежнему полезен при непрерывном интеграционном развертывании проекта, что может улучшить качество кода проекта. Другими словами, используя его в качестве конвейера при развертывании непрерывной интеграции в файле gitlab-ci.yml в корневом каталоге вашего проекта, вы можете контролировать качество своего онлайн-кода. Название этого инструмента — SonarQube, также существует инструмент для JetBrains, выполняющий ту же функцию — Qodana.

Эта статья в основном представляет собой целевое введение в инструмент SonarQube. Статья разделена на четыре части. В первой части объясняется, какие преимущества вы обычно получаете от использования этого типа инструмента. Во второй части объясняются приготовления, необходимые для создания среды запуска инструмента. В разделе 3 описан подробный процесс развертывания. Последняя часть завершается.

1. Каковы преимущества использования этого типа инструмента?

Просто и понятно, какие проблемы в коде обычно выявляют эти инструменты?

1.Не соблюдение стандартов.Например, некоторые list Обнаружение ненулевого типа данных, раньше я привык использовать его xx.size()>0 Если вы используете этот инструмент для определения короткой позиции, вам будет предложено сделать свою личность более персонализированной. метод xx.isEmpty();

2.потенциальные дефекты.Например, если вы установили checkstyle Инструмент определения формата дает вам советы, например, как импортировать неиспользуемые пакеты и т. д.

3.Распределение кода высокой сложности.Возможно, это должен быть абстрактный класс,Ни один метод не был предложен,Весь код написан в файле, ориентированном на процесс.,это каждый раз будет предоставлять вам предложения по оптимизации.

4.Избыточный код и дублирование.Например, изменился способ реализации кода.,Чтобы предотвратить повторное изменение требований к продукту, предыдущий код,Аннотированный,дам тебе подсказки,Избавьтесь от этих избыточных кодов.

5.Недостаточно или слишком много комментариев.этот Больше никаких объяснений。

6.Модульных тестов нет.Нормально для функций разработки,Здесь есть методы тестирования, соответствующие функциям.

7.Плохой дизайн.этотсуществовать java Особенно очевидно в Java Функции, которые несет каждый уровень на логическом уровне, очень ясны. Вероятно, нереально обеспечить беспрепятственный поток параметров на каждом уровне, поэтому требуется передача параметров на каждом уровне структуры. В настоящее время следование стандартам — идеальный способ справиться с этой проблемой, но принудительное повторное использование кажется недостаточным и делает всю структуру запутанной.

2. Экологическая подготовка

• Java-среда
• Среда Maven
• Платформа SonarQube
• gitlab
• Jenkins платформа или gitlab-runner этот gitlab Расширение инструмента хостинга кода. Эта статья предназначена для gitlab-runner объяснять
• База данных (например, mysql)

Если у вас есть какие-либо вопросы по поводу вышеуказанной установки, вы можете сами погуглить.

3. Процесс развертывания

1. Напишите файл конфигурации gitlab-ci.yml.

gitlab Родная установка
stages
- test

job1:
stage: test
only: - master
script: - sonar-scanner -Dsonar.projectKey=abc -Dsonar.host.url=<http://172.18.16.50:9000> -Dsonar.login=6d190aebe5c01fd18f22c212f47fc5f657a29f1d -Dsonar.java.binaries=.

gitlab установка докера
image:
  name: sonarsource/sonar-scanner-cli:latest
  entrypoint: [""]
variables:
  # ТОКЕН генерируется при создании проекта в sonarqube
  SONAR_TOKEN: "09904533c04eee38bc6c6d5b4acfc4fb73865626"
  SONAR_HOST_URL: "http://192.168.102.27:9000/"
  GIT_DEPTH: 0
sonarqube-check:
  stage: test
  script:
    # Идентификация проекта в sonarqube
    - sonar-scanner -Dsonar.qualitygate.wait=true -Dsonar.projectKey=firsttest -Dsonar.java.binaries=.
  allow_failure: true
  only: # Обнаруживаются только основные запросы на слияние и отправка кода основной ветки. Версия sonarqube-ce поддерживает только анализ ветки dev.
    - merge_requests
    - dev

1. После отправки кода в gitlab автоматически выполняется проверка кода на соответствие!

gitlab-ci успешно запущен

gitlab-ci.yml выполнен успешно

sonarQube успешно обнаружен

4. Резюме

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