10 Indikatoren, auf die Sie bei der Anwendung von Code-Inspektionsregeln achten müssen

[Vorschau der Live-Übertragung] 99 Yuan virtuelle Cloud-Maschine × 9 Yuan native Cloud-Architektur √

Dieser Artikel wurde von der Huawei Cloud Community geteilt: „ Auf welche Indikatoren konzentrieren sich Code-Inspektionsregeln im Allgemeinen?“ ", Autor: gentle_zhou.

Im Messvorgangs-Dashboard des Code-Inspektionsdienstes gibt es zusätzlich zu dem zuvor erwähnten Alarmbetriebsmodul (Informationen zu den Indikatoren finden Sie in diesem Artikel „Auf welche Indikatoren konzentrieren sich Code-Inspektion-Alarmvorgänge im Allgemeinen? “) ein Modul, das dies tut definitiv vorhanden ist die Regeloperation. . Dieses Modul konzentriert sich auf die Analyse, Verarbeitung und Berichterstattung von Code-Inspektionsregeln. Für Teamprojektmanager kann es den Gesamtstatus der Regeln überwachen und verwalten. Weitere Informationen finden Sie in meinem vorherigen Artikel „Warum statische Code- Inspektion Regeln erfordert“. Operationen? 》.

Heute werden wir ausführlicher sprechen. Auf welche Indikatoren achten Benutzer im Regeloperationsmodul des Dashboards im Allgemeinen? Es kann grob in Daten in der Dimension der Regel selbst unterteilt werden: Regelname, Regelversion, Regelinhalt, verwandte Sprachen, verwandte Tools und Kategorien, Alarmkategorien, Anwendungsbereich; und Daten in der Regelzuordnungsdimension: Informationen über die Wartungsperson, die für die Regel verantwortlich ist, Regeln Die zugehörige Referenzsituation, der mit der Regel verbundene Regelsatz.

Die Dimension der Regel selbst

Regelname

Der Name der Regel ermöglicht es Benutzern, die Bedeutung und Funktion der Regel grob zu verstehen, wodurch es für Benutzer einfacher wird, die Regel zu identifizieren und zu verwalten. Als einer der grundlegendsten Indikatoren im Regelbetrieb kann er Benutzern dabei helfen, schnell zu verstehen und zu identifizieren, welche Regeln in Unternehmen, Branchen und Abteilungen vorhanden sind und welche Regeln verschiedene Abteilungen bevorzugt verwenden.

Nehmen wir als Beispiel den Code-Inspektionsdienst Huawei Cloud CodeArts Check. Die Gestaltung der Regelnamen basiert auf Klarheit und Einfachheit:

Regelversion

Da sich die Regeln weiterentwickeln, wird es zwangsläufig mehrere Versionen geben, darunter verschiedene Hauptversionen (die das ganze Jahr oder ein halbes Jahr lang iteriert werden können) und Nebenversionen (unregelmäßige kleine Optimierungsverbesserungen). Die Version ist im Allgemeinen eine Alternative zur Versionsnummer, und die Versionsnummer trägt normalerweise auch eine Uhrzeit und ein Datum (die ihre Erstellungszeit/Änderungszeit/Online-Zeit usw. darstellen), um die Aktualisierung der Regeln widerzuspiegeln.

Auf dem Betriebs-Dashboard des Code-Inspektionsdienstes muss ein Datensatz der Regelversion im Regelbetriebsmodul vorhanden sein. Regelversionsindikatoren können Benutzern nicht nur dabei helfen, Regeln in verschiedenen Versionen zu unterscheiden, sondern auch Managern dabei helfen, den Entwicklungsprozess von Regeln zu verstehen, die Auswirkungen von Regeln auf das Geschäft in verschiedenen Versionen, den Entwicklungsverlauf der Regeloptimierung und die Stabilität von Regeln zu bewerten.

Regelinhalt

Wenn der Regelname Benutzern helfen kann, die Bedeutung der Regel grob zu verstehen, soll der Inhalt der Regel es Benutzern ermöglichen, klar zu verstehen, was die Regel ist, den Hintergrund der Regel, wo die Regel verwendet werden kann, richtige und falsche Beispiele dafür Regel und Regelreferenz. Welche Normen und so weiter.

Man kann sagen, dass der Inhalt der Regeln ein sehr wichtiger Indikator ist, der Benutzern hilft, die Regeln zu verstehen und ihnen dabei zu helfen, die Prüfmethoden und Standards der Regeln zu beherrschen. Daher geht es den Benutzern des operativen Dashboards darum, ob eine Regel vollständigen und detaillierten Inhalt hat und ob der Inhalt korrekt und detailliert ist.

Am Beispiel des Huawei Cloud CodeArts Check-Codeinspektionsdienstes ist die Übersicht in Beschreibungen, korrekte Beispiele, Fehlerbeispiele und Reparaturvorschläge unterteilt. Sehen Sie sich die detaillierte Einführung des Regelinhalts an:

Alarmkategorie

Genau wie ich in „Warum muss die statische Code-Inspektion die Regeln befolgen?“ gesagt habe. „Wie im Artikel erwähnt, ähneln Regeln den gesetzlichen Bestimmungen. Gehört die verletzte Regel also zu den zivilrechtlichen, verkehrsrechtlichen oder strafrechtlichen Kategorien?“ Zu diesem Zeitpunkt muss die Alarmkategorie angezeigt werden.

Im Allgemeinen können Alarmkategorien für die Anzeige in drei Hauptkategorien unterteilt werden: Sicherheitskategorie, Qualitätskategorie und Stilkategorie (natürlich können Qualitätskategorien und Stilkategorien auch zusammen angezeigt werden). Wenn die Qualitätsabteilung des Unternehmens der Meinung ist, dass die Einteilung in die drei Kategorien etwas grobkörnig ist, kann sie diese weiter unterteilen.

Nehmen Sie als Beispiel die Klassifizierung des Huawei Cloud CodeArts Check-Codeinspektionsdienstes (das in der Klassifizierungsspalte erwähnte „Sicherheitsverbesserungsfunktionspaket“ ist ein erweiterter Zweig der Sicherheitskategorie und ermöglicht eine tiefere Überprüfung einiger Sicherheitsproblemszenarien):

Geltungsbereich

Wenn es um den Anwendungsbereich geht, müssen wir zunächst kurz die Verwendung des Code-Inspektionstools vorstellen. Zusätzlich zu den üblichen Cloud-Diensten, dem Scannen auf Zugriffskontrollebene, das vom Code-Warehouse bereitgestellt wird, und dem Scannen auf Versionsebene, das von der Pipeline bereitgestellt/manuell ausgelöst wird, ist auch das Scannen von IDE-Plug-ins, das Entwickler benötigen, um Code in der lokalen IDE zu entwickeln, von entscheidender Bedeutung. Nennen wir diese drei Nutzungsmethoden vorübergehend Versionsebene, Zugriffskontrollebene und IDE-Plug-In-Ebene. Dann können diese drei Methoden als der Anwendungsbereich des Dienstes bezeichnet werden.

Für Regeln gilt ebenfalls der Geltungsbereich. Der anwendbare Geltungsbereich der Regeln wird anhand der Merkmale der Regeln selbst unterteilt, ob eine Kompilierung erforderlich ist, ob der unterstützende Engine-Scan eine große Menge an Rechenressourcen erfordert, ob eine Taint-Analyse erforderlich ist usw. Einige Regeln, die weniger Rechenressourcen beanspruchen und keine Kompilierung erfordern, können als Scanbereich des IDE-Plug-Ins ausgewählt werden. Im Regeloperationsmodul des Operations-Dashboards ermöglicht die Klassifizierung von Regeln nach Anwendungsbereich Benutzern zu verstehen, welche Regeln für die Anwendung in unterschiedlichen Bereichen ausgewählt werden können.

Dimensionen der Regelzuordnung

Informationen zur für die Wartung verantwortlichen Person im Zusammenhang mit Regeln

Die Regeln werden mit der Geschäftsentwicklung und der Aktualisierung des Schwachstellenbewusstseins in der Branche kontinuierlich aktualisiert und optimiert. Daher sind eine eigene Wartungsabteilung und ein Wartungsverantwortlicher erforderlich, die für die Online- und Offline-Änderung, Freigabe und Verwaltung der Regeln verantwortlich sind .

Im Allgemeinen gibt es zwei Gründe für die Anzeige der Informationen zur Wartungsverantwortlichen Person im Zusammenhang mit den Regeln im Betriebs-Dashboard:

Im Allgemeinen sollte derjenige, der die Regeln entwirft und entwickelt, sie auch in Zukunft pflegen. Daher kann die Anzeige der Informationen der für die Wartung verantwortlichen Person im Dashboard den Benutzern das Verständnis der Quelle und des Hintergrunds der Regeln erleichtern und die Glaubwürdigkeit erhöhen und Autorität der Regeln.
Für Benutzer ist es praktisch, schnell die entsprechenden Verantwortlichen zu kontaktieren, wenn sie im Dashboard auf regelbezogene Probleme oder Vorschläge stoßen, wodurch die Kommunikationskosten zwischen Benutzern und Entwicklern reduziert werden.

Mit Regeln verknüpfte Referenzen

Sobald eine Regel entwickelt ist, wird sie, solange sie sinnvoll und effektiv ist, von verschiedenen Produktlinien, Abteilungen und Projekten innerhalb des Unternehmens übernommen und verwendet. Theoretisch gilt: Je mehr Referenzen sie hat, desto mehr repräsentiert sie die universelle Anpassungsfähigkeit , Wirksamkeit und Einfluss der Regel.

Im Allgemeinen gibt es drei Gründe für die Anzeige von Zitierinformationen im Zusammenhang mit Regeln im Operations-Dashboard:

Helfen Sie Benutzern und potenziellen Benutzern von Regeln, die anwendbaren Szenarien und Anwendungsobjekte von Regeln zu verstehen, unterstützen Sie sie bei der Auswahl geeigneter Regeln und verbessern Sie die Wirkung der Codeüberprüfung.
Bieten Sie der für die Aufrechterhaltung der Regeln verantwortlichen Person eine Plattform, um den Anwendungsbereich ihrer Entwicklungsregeln zu verstehen und sie mit ihren inneren erwarteten Auswirkungen zu vergleichen. Gleichzeitig können sie durch Kommunikation und Kommunikation auch rechtzeitig Probleme und Mängel der Regeln erkennen Feedback mit relevanten Stakeholdern dieser nutzenden Abteilungen.
Für Manager und Vorgesetzte von Code-Inspektionsdiensten ist es praktisch, den Wert und Einfluss von Regeln zu verstehen und die Unterschiede zwischen verschiedenen Regeln zu vergleichen und zu bewerten.

Der mit der Regel verknüpfte Regelsatz

Wenn Benutzer des Code-Inspektionsdienstes Regeln verwenden, wählen sie die Regeln nicht direkt zum Scannen aus. Stattdessen wählen sie einige Regeln aus und fügen sie basierend auf ihren Geschäftsmerkmalen, Codespezifikationen, Sicherheitsstandards oder Qualitätsanforderungen, die erfüllt sein müssen, zu einem Satz zusammen gefolgt. . Dieser Satz wird im Allgemeinen als Regelsatz bezeichnet, der Benutzern die Verwaltung von Hinzufügungen, Löschungen und Abfragen erleichtern kann.

Die Anzeigeregeln im Betriebs-Dashboard werden von diesen Regelsätzen verwendet, die den Benutzern das Verständnis erleichtern können:

Anhand der Quelle und der Grundlage der Regel können Benutzer der Regel verstehen, warum diese Regel in unserer Abteilung und unserem Projekt vorkommt, aus welchem Regelsatz sie stammt und ob es angemessen ist, vom aktuellen Projekt referenziert zu werden.
Die Zuordnung und Klassifizierung von Regeln ermöglicht es der für die Pflege der Regeln verantwortlichen Person zu verstehen, in welchen Regelsätzen die Regeln gesammelt werden, ob eine solche Verwendung mit der ursprünglichen Absicht übereinstimmt und ob die Regeln entsprechend diesem Szenario ergänzt und optimiert werden können.
Die Verteilung und Abdeckung von Regeln ermöglicht es Managern und Vorgesetzten von Code-Inspektionsdiensten, den Wert und Einfluss von Regeln zu bewerten sowie die Wirksamkeit und Glaubwürdigkeit von Regeln in verschiedenen Regelsätzen zu vergleichen und zu bewerten.

Wenn das Geschäftsvolumen des Unternehmens groß ist und die Anzahl der Projekte zunimmt, wird die Anzahl der Regelsätze zwangsläufig unkontrolliert zunehmen. Es ist also keine gute Möglichkeit, blind anzuzeigen, welche Regelsätze von den Regeln übernommen werden. Wir können einige typische Regelsätze auswählen, die von allen anerkannt werden, um sie zu bewerten, z. B. ob die Regeln vom Regelsatz auf Unternehmensebene übernommen werden. Wenn der Einfluss und die Wirkung einer Regel vom gesamten Unternehmen erkannt werden, wird sie definitiv einbezogen . Zentralisierte Regeln auf Unternehmensebene. Anstatt alle übernommenen Regelsätze anzuzeigen, können wir daher versuchen zu zeigen, ob diese Regel vom Regelsatz auf Unternehmensebene übernommen wurde. Dieser Effekt ist für Benutzer möglicherweise akzeptabler und fördert die Motivation der Verantwortlichen für die Regelpflege, sich zu verbessern.

abschließend

Durch die Beachtung der oben genannten Indikatorinformationen kann das zuständige Personal Schlüsseldaten zu den Regeln erhalten und den Benutzern dabei helfen, die Wirksamkeit, Rationalität, Wartbarkeit und Anpassungsfähigkeit der Regeln zu verstehen und zu bewerten. Benutzer können außerdem unnötige Zeit- und Ressourcenverschwendung vermeiden, unzuverlässige und inkonsistente Regeln aus Betriebs- und Wartungssicht identifizieren, Unklarheiten und Verwirrung vermeiden und die Ausführungswirkung der Regeln verbessern. Das ultimative Ziel besteht natürlich darin, die Benutzerzufriedenheit sicherzustellen. .

Klicken Sie hier, um zu folgen und so schnell wie möglich mehr über die neuen Technologien von Huawei Cloud zu erfahren~