logifix

Logifix

Logifix เป็นเครื่องมือที่ใช้ดาต้าล็อกสำหรับการแก้ไขการละเมิดการวิเคราะห์แบบคงที่โดยอัตโนมัติในซอร์สโค้ด 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

แม็กอส

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 คืออะไร?

Logifix เป็นระบบการเขียนซ้ำสำหรับการวิเคราะห์สำหรับซอร์สโค้ด Java ซึ่งหมายความว่าคุณกำหนด (หรือใช้การวิเคราะห์ที่กำหนดไว้ล่วงหน้า) และการแปลงที่ทำงานร่วมกันเพื่อปรับปรุงรหัสของคุณ การวิเคราะห์และการแปลงถูกเขียนขึ้นใน Datalog ภาษาที่ใช้ตรรกะที่มีการเปิดเผยอย่างสูงและรวมกันและถูกล่ามโซ่โดยอัตโนมัติโดยเอ็นจิ้นการเขียนใหม่

คุณสมบัติ

การใช้เหตุผลเชิงอนุรักษ์อัจฉริยะ

Logifix เป็นมากกว่าระบบการค้นหาและแทนที่ มันดำเนินการเขียนซ้ำในหลายขั้นตอนและสามารถบรรลุการให้เหตุผลเชิงอนุรักษ์อัจฉริยะโดยการสร้างจุดที่เปล่งออกมาในกราฟการเขียนซ้ำ

ความเร็ว

Logifix ถูกนำไปใช้ในภาษาดาต้าล็อกประสิทธิภาพสูงที่สังเคราะห์เป็นรหัส C ++ แบบมัลติเธรด มันขนานกันอย่างหนักแม้ว่าจะทำงานกับไฟล์เดียวและมักจะวิเคราะห์โครงการขนาดใหญ่หลายพันไฟล์ในไม่กี่วินาทีในฮาร์ดแวร์ที่ทันสมัย หากโครงการของคุณช้าในการวิเคราะห์ถือว่าเป็นข้อผิดพลาดและคุณควรยื่นรายงานข้อผิดพลาด

การจับกุม

Logifix ได้รับการออกแบบทางวิศวกรรมเพื่อผลิตแพตช์เหมือนมนุษย์ที่พร้อมใช้งานโดยการออกแบบโดยไม่ต้องมีการดัดแปลงด้วยตนเอง

ตัวอย่าง

นี่คือตัวอย่างบางส่วนของแพตช์ที่สร้างขึ้นโดย Logifix

แก้ไขการวนซ้ำที่ไม่มีประสิทธิภาพผ่านแผนที่#คีย์

  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

          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(" ");
      }

ลดความซับซ้อนของรหัสโดยใช้แผนที่ :: 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());
  } 

คำถามที่พบบ่อย

ฉันจะหาการเปลี่ยนแปลงที่กำหนดไว้ล่วงหน้าได้ที่ไหน

ดูเอกสาร/การเปลี่ยนรูปแบบที่กำหนดไว้ล่วงหน้า MD หรือซอร์สโค้ด SRC/กฎ

ฉันสามารถสร้างการเปลี่ยนแปลงของตัวเองได้หรือไม่?

ใช่! ดูเอกสาร/การสร้างการเปลี่ยนแปลงของคุณเอง

ฉันจะสร้างจากแหล่งที่มาได้อย่างไร?

ดู docs/building.md

โครงการที่เกี่ยวข้อง

หากคุณพบว่าโครงการนี้น่าสนใจโปรดตรวจสอบสิ่งเหล่านี้ด้วย:

• souffle -lang/souffle - คอมไพเลอร์ datalog ที่ใช้โดย logifix
• Egraphs -Good/Egg - ห้องสมุดที่ดีสำหรับความอิ่มตัวของระบบการเขียนซ้ำอย่างมีประสิทธิภาพ
• comby-tools/comby-เครื่องมือการค้นหาและแทนที่ที่มีน้ำหนักเบา