Wiederverwendbare packages erstellen
- Zuletzt aktualisiert2021/07/06
Lesen Sie die Leitlinien, um zu verstehen, wie packages für die Wiederverwendbarkeit zu erstellen sind.
- Die eingehenden Daten kennen
- Wenn Sie Felder festlegen, die Ihr Aktions-package vom Benutzer benötigt, geben Sie bei der Festlegung des Attributtyps Einzelheiten an, um die Art der Daten zu begrenzen, die Ihr package empfängt.
- Begrenzen Sie die Eingaben, um den Kontrollaufwand beim Eingang des Pakets zu verringern.
- Javadoc enthält 34 definierte Attributtypen, die Sie bei der Erstellung Ihres packages überprüfen sollten, um die geeigneten Feldtypen auszuwählen.
- Stellen Sie Ihr package so ein, dass es einen gespeicherten Wert annimmt. Wenn Ihr package zum Beispiel im Namen des bots API-Aufrufe tätigt, stellen Sie sicher, dass der AttributeType des Aktion-Eingabefelds für den API-Schlüssel oder ein Token auf credential gesetzt ist. Auf diese Weise werden die Nutzer ermutigt, einen im Credential Vault gespeicherten Wert für sensible Eingabedaten zu verwenden, die das package erfordert.
- Bezeichnungen angemessen verwenden
- Verwenden Sie in der Anmerkung CommandPkg 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 den gleichen Benennungsstil, wie er im standardmäßigen Aktions-packages verwendet wird.
- Jede Aktion ist ein untergeordnetes Element eines packages, und die Aktionsbezeichnung 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 die Anmerkung @Pkg. Dies ermöglicht package-Entwicklern, 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"
- Einheitstests Ihrer Komponenten
- Erstellen Sie während der package-Entwicklung Einheitstests, um zu überprüfen, ob die einzelnen Komponenten und Aktionen des packages 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 Funktionalitätsmängel in frühen Phasen des Entwicklungsprozesses.
- Umgang mit Fehlern
- Schließen Sie die Fehlerbehandlung in die bot-Logik ein, um sicherzustellen, dass alle Fehler ordnungsgemäß behandelt werden. Wenn ein Fehler nicht behandelt wird, kann er einen bot Runner daran hindern, andere Aufgaben auszuführen.
- Erstellen Sie aussagekräftige Fehlermeldungen, die den bot-Verbrauchern bei der Fehlerbehebung helfen können.
- Als package-Entwickler sollten Sie diese Empfehlungen beachten:
- Verwenden Sie den Block Verwenden/Erfassen, um auf einen Fehler zu reagieren.
- Verwenden Sie einen Multi-Erfassungs-Block, um bestimmte Fehler zu finden, und verwenden Sie 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])); }
- Befolgen Sie das Prinzip der Alleinverantwortung
- Ein package ist eine Sammlung von Aktionen. Jede Aktion innerhalb eines packages muss eine einzige Zuständigkeit haben, und diese Zuständigkeit muss von der Aktion gekapselt sein.
- Die Befolgung des Prinzips der Alleinverantwortung erleichtert Ihren package-Verbrauchern die Umsetzung, vereinfacht das Testen und vermeidet unnötige Änderungen.
- Mit den von Ihnen angebotenen Aktionen können package-Verbraucher die Art und Weise, wie sie Ihr package in ihren bots nutzen, individuell anpassen und ihre bots so effizient wie möglich gestalten.
- Beispiele nennen
- Wenn Sie packages zum Bot Store einreichen, fügen Sie einen Demo-bot bei, der die Verwendung des packages demonstriert.
- Verwenden Sie die Automation 360-Aktionen und erlauben Sie package-Verbrauchern, diese Aktionen zu verwenden, um dessen bot-Fähigkeiten zu nutzen.
- Stellen Sie immer Muster-bots mit Beschreibungen zur Verfügung, um Ihren package-Verbrauchern das Wissen zu vermitteln, das sie benötigen, um die richtige Verwendung zu verstehen.