Wiederverwendbare Gebäude packages
Lesen Sie die Richtlinien, um zu verstehen, wie man packages für Wiederverwendbarkeit.
- Kennen Sie Ihre eingehenden Daten
- Wenn Sie Felder festlegen, die Ihre Aktion package vom Benutzer benötigt werden, sollten Sie den Attributtyp genau festlegen, um die Art der Daten zu begrenzen, die Ihr package erhält.
- Begrenzen Sie die Eingaben, um den Kontrollaufwand beim Eingang des Pakets zu verringern.
- Javadoc enthält 34 definierte Attributtypen, die Sie bei der Erstellung Ihrer package um die passenden Feldtypen auszuwählen.
- Stellen Sie Ihr package so ein, dass es einen gespeicherten Wert annimmt. Zum Beispiel, im Namen der botIhr package API-Aufrufe tätigt, überprüfen Sie, ob das AttributTyp des Aktionseingabefelds für den API-Schlüssel oder ein Token auf Berechtigungsnachweis. Auf diese Weise werden die Benutzer ermutigt, einen Wert zu verwenden, der in der Credential Vault für sensible Eingabedaten, die der package erfordert.
- Etiketten angemessen verwenden
- Im CommandPkg Anmerkung verwenden Sie entsprechend unterschiedliche Bezeichnungen, node_labels und Beschreibungen.
- Verwenden Sie diese Bezeichnungen als kurze Beschreibungen Ihrer Aktion und verwenden Sie nur wenige Wörter, um eine Aktion zu beschreiben.
- Wiederholen Sie denselben Benennungsstil, wie er in der Standardaktion dargestellt ist packages.
- Jede Aktion ist ein untergeordnetes Element von a packageund die Bezeichnung der Aktion wird zusammen mit dem package Symbol im Bereich Aktionen angezeigt. Verwenden Sie kurze Namen, um jede Aktion zu beschreiben.
- Dokumentieren Sie ein erwartetes Eingabeformat für bestimmte Felder. Verwenden Sie die Parameterbeschreibung für den @Pkg Bemerkung. Dies ermöglicht package Entwickler die Möglichkeit, das Format, die Anforderungen oder die Daten zu überprüfen, die für ein bestimmtes Eingabefeld verwendet werden müssen. Beispiel:
@Pkg(label = "Start Date", description="Date Format as MM/DD/YYYY"
- Einheitstest Ihrer Komponenten
- Während der package Entwicklung erstellen Sie Einheitstests, um zu überprüfen, ob jede Komponente und jede Aktion des package wie erwartet funktionieren.
- Validieren Sie das Verhalten einer einzelnen Testeinheit, einer einzelnen Klasse oder einer einzelnen Aktion, um sicherzustellen, dass sie wie erwartet funktioniert.
- Prüfen und dokumentieren Sie alle Funktions- und Funktionsmängel in einem frühen Stadium des Entwicklungsprozesses.
- Umgang mit Fehlern
- Binden Sie die Fehlerbehandlung in die bot Logik ein, um sicherzustellen, dass alle Fehler ordnungsgemäß behandelt werden. Wenn ein Fehler nicht behandelt wird, kann er verhindern, dass ein bot Läufer daran hindern, andere Aufgaben auszuführen.
- Erstellen Sie aussagekräftige Fehlermeldungen, die den bot Verbrauchern bei der Fehlerbehebung helfen.
- Als package Entwickler sollten Sie diese Empfehlungen beachten:
- Verwenden Sie Try/Catch Block, um auf einen Fehler zu reagieren.
- Verwenden Sie einen Multi-Catch-Block, um bestimmte Fehler zu finden, und verwenden Sie die BotCommandException um angepasste Fehlermeldungen zurückzugeben. Beispiel:
//create array of 3 items int[] myIntArray = new int[]{1, 0, 7}; try { //print 4th item in array System.out.println(myIntArray[3]); //Perform operation on first and second items in array int result = myIntArray[0] / myIntArray[1]; } catch (ArrayIndexOutOfBoundsException e) { //Throw custom message for IndexOutofBounds throw new BotCommandException("The array does have the number of expected items."); } catch (ArithmeticException e) { //Throw custom message on Atithmetic Exception throw new BotCommandException("Math Operation Error with " + Integer.toString(myIntArray[0]) + " and " + Integer.toString(myIntArray[1])); }
- Befolgung des Prinzips der Alleinverantwortung
- A package ist eine Sammlung von Aktionen. Jede Aktion innerhalb einer package muss eine einzige Zuständigkeit haben, und diese Zuständigkeit muss von dieser Aktion gekapselt sein.
- Die Einhaltung des Prinzips der einzigen Zuständigkeit hilft Ihren package Verbraucher bei der einfachen Umsetzung, vereinfacht das Testen und vermeidet unnötige Änderungen.
- Die Aktionen, die Sie anbieten, ermöglichen package Verbraucher die Möglichkeit, die Art und Weise, wie sie Ihr package innerhalb ihrer botsund können ihnen helfen, ihre bots so effizient wie möglich zu sein.
- Nennen Sie Beispiele
- Bei der Einreichung packages an die Bot Store eine Demo enthalten bot ein, die die Verwendung der package.
- Verwenden Sie die Automation 360 Aktionen und ermöglichen package Verbraucher, diese Aktionen zu nutzen, um ihre bot Fähigkeiten.
- Stellen Sie immer Muster bots mit Beschreibungen, damit Ihre package Verbrauchern das Wissen zu vermitteln, das sie benötigen, um die richtige Verwendung zu verstehen.