logifix

Логификс

Logifix-это инструмент на основе Datalog для автоматического исправления нарушений статического анализа в исходном коде Java. Logifix может использоваться для исправления нарушений статического анализа для статических анализаторов, таких как Sonarqube, PMD или SpotBugs, а также для модернизации устаревшего кода или даже для автоматического обеспечения соблюдения пользовательских правил, специфичных для вашей базы кода.

Демо

Demo.mp4

Начиная

1. Установите

Предварительно построенные и без зависимости двоичные файлы предоставляются для систем Linux на основе MacOS и GNU.

Ubuntu/Debian

curl -L https://github.com/lyxell/logifix/releases/latest/download/logifix-x86_64-linux-gnu.gz | gunzip -c - > /tmp/logifix
chmod +x /tmp/logifix
sudo mv /tmp/logifix /usr/local/bin

macOS

curl -L https://github.com/lyxell/logifix/releases/latest/download/logifix-x86_64-macos.gz | gunzip -c - > /tmp/logifix
chmod +x /tmp/logifix
sudo mv /tmp/logifix /usr/local/bin

2. бежать

• Запустите logifix path/to/your/project в вашем терминале, запустите logifix --help , чтобы получить помощь

Что такое логификс?

Logifix-это система переписывания анализа для исходного кода Java. Это означает, что вы определяете (или используете предопределенный) анализ и преобразования, которые все работают вместе для улучшения вашего кода. Анализ и преобразования написаны в очень декларативной логике языковой данных и автоматически объединяются и автоматически приковываются.

Функции

Интеллектуальные уравненные рассуждения

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

Скорость

Logifix реализован на высокопроизводительным диалектом данных, который синтезируется в многопоточный код C ++. Он сильно параллельно даже при работе над одним файлом и обычно анализирует крупные проекты из тысяч файлов за несколько секунд на современном оборудовании. Если ваш проект медленно анализируется, он считается ошибкой, и вы должны подать отчет об ошибке.

Слияние

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

Примеры

Вот несколько примеров патчей, сгенерированных Logifix.

Исправить неэффективную итерацию по карте#keyset

  public static void sign(String token, Map<String, String> params) {
      List<String> list = new ArrayList();
      String tokenClientSlat = "";
-     for (String key : params.keySet()) {
+     for (Map.Entry<String, String> entry : params.entrySet()) {
+         String key = entry.getKey();
          if (key.equals("token_client_salt")) {
-             tokenClientSlat = params.get(key);
+             tokenClientSlat = entry.getValue();
          }
-         String paramString = key + "=" + params.get(key);
+         String paramString = key + "=" + entry.getValue();
          list.add(paramString);
      }
      Collections.sort(list);

Упростить код, используя Try-with-resources

          continue;
      } 
-     try {
-         JarFile nextJarFile = new JarFile(absNextFile);
-         try {
-             Attributes attrs = getMainAttrs(nextJarFile);
-             Set<Extension> newExtensions = getReferencedExtensions(attrs);
-             result.addAll(newExtensions);
-             filesToProcess.addAll(extensionsToFiles(newExtensions));
-         } finally {
-             nextJarFile.close();
-         }
+     try (JarFile nextJarFile = new JarFile(absNextFile)) {
+         Attributes attrs = getMainAttrs(nextJarFile);
+         Set<Extension> newExtensions = getReferencedExtensions(attrs);
+         result.addAll(newExtensions);
+         filesToProcess.addAll(extensionsToFiles(newExtensions));
      } catch (Exception e) {
          invalidLibPaths.append(nextFile.getPath()).append(" ");
      }

Упростить код с помощью map :: computeifabsent

  private final Map<Class<?>, String> requestQueueNameCache = new ConcurrentHashMap<>();
     
  public String getRequestQueueName(Class<?> remoteInterface) {
-     String str = requestQueueNameCache.get(remoteInterface);
-     if (str == null) {
-         str = "{" + name + ":" + remoteInterface.getName() + "}";
-         requestQueueNameCache.put(remoteInterface, str);
-     }
-     return str;
+     return requestQueueNameCache.computeIfAbsent(remoteInterface, k -> "{" + name + ":" + k.getName() + "}");
  }

Упростить код с помощью потоков

  @Override
  public List<SpoonFile> getAllJavaFiles() {
-     List<SpoonFile> result = new ArrayList<>();
-
-     for (SpoonFile f : getAllFiles()) {
-         if (f.isJava()) {
-             result.add(f);
-         }
-     }
-
-     return result;
+     return getAllFiles().stream().filter(SpoonFile::isJava).collect(Collectors.toList());
  } 

Часто задаваемые вопросы

Где я могу найти предопределенные преобразования?

См. Docs/Предопределенные трансформации.md или исходный код SRC/Правила.

Могу ли я создать свои собственные преобразования?

Да! См. Docs/Создание ваших собственных трансформаций.md.

Как построить из источника?

Смотрите документы/здание.md.

Связанные проекты

Если вы найдете этот проект интересным, обязательно также проверите это:

• Souffle -Lang/Souffle - компилятор Datalog, используемый Logifix
• EGRAPHS -Good/Яйцо - хорошая библиотека для эффективного насыщения равенства систем переписывания
• Comby-Tools/Comby-легкий инструмент для поиска и заведения на основе AST