Gebäude wiederverwendbar packages
Lesen Sie die Richtlinien durch, um zu verstehen, wie die Wiederverwendbarkeit packages erreicht werden kann.
- Kennen Sie Ihre eingehenden Daten
- Wenn Sie Felder festlegen, die für Ihre Aktion package vom Benutzer erforderlich sind, geben Sie Einzelheiten zum Festlegen des Attributtyps an, um die Arten von Daten einzuschränken, die Ihr package empfängt.
- Begrenzen Sie die Eingabe, um die Belastung durch Prüfungen zu verringern, die beim Empfang des Pakets durchgeführt werden müssen.
- Javadoc enthält 34 definierte Attributtypen. Überprüfen Sie diese, wenn Sie Ihren package erstellen, um die entsprechenden Feldtypen auszuwählen.
- Stellen Sie Ihr package so ein, dass es einen gespeicherten Wert annimmt. Stellen Sie bot package beispielsweise im Namen des , der API-Aufrufe durchführt, sicher, dass der AttributeType des Aktionseingabefelds für den API-Schlüssel oder ein Token auf Credentialgesetzt ist. Auf diese Weise wird Benutzern empfohlen, einen im gespeicherten Wert Credential Vault für vertrauliche Eingabedaten zu verwenden, die vom package benötigt werden.
- Verwenden Sie die Etiketten entsprechend
- Verwenden Sie in der CommandPkg-Beschriftung verschiedene Bezeichnungen, Node_Labels, Und Beschreibungen entsprechend.
- Verwenden Sie diese Bezeichnungen als kurze Beschreibungen Ihrer Aktion und verwenden Sie nur wenige Wörter, um eine Aktion zu beschreiben.
- Replizieren Sie den gleichen Namensstil, wie er in der Standardaktion packagesdargestellt wird.
- Jede Aktion ist ein untergeordnetes Element eines package, und die Aktionsbezeichnung wird zusammen mit dem package Symbol im Aktionsbereich angezeigt. Verwenden Sie Kurznamen, um jede Aktion zu beschreiben.
- Dokumentieren Sie ein erwartetes Eingabeformat für bestimmte Felder. Verwenden Sie die Parameterbeschreibung für die Anmerkung @Pkg . Dadurch können package Entwickler das Format, die Anforderung oder die Daten überprüfen, die für ein bestimmtes Eingabefeld verwendet werden müssen. z. B.
@Pkg(label = "Start Date", description="Date Format as MM/DD/YYYY"
- Testen Sie Ihre Komponenten
- package Erstellen Sie während der Entwicklung Unit-Tests, um zu überprüfen, ob jede Komponente und die Aktion des wie package erwartet funktionieren.
- Validieren Sie das Verhalten der einzelnen Testeinheit, einer einzelnen Klasse oder einer einzelnen Aktion, um sicherzustellen, dass sie wie erwartet funktioniert.
- Überprüfung und Dokumentation von Funktionsfehlern 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 behoben wird, kann dies verhindern, dass ein bot Läufer andere Aufgaben ausführt.
- Erstellen Sie aussagekräftige Fehlermeldungen, die Kunden bot bei der Fehlerbehebung helfen können.
- Beachten Sie als package Entwickler die folgenden Empfehlungen:
- Verwenden Sie den Try/Catch -Block, um Fehler zu beheben.
- Verwenden Sie einen Multi-Catch-Block, um bestimmte Fehler zu finden, und verwenden Sie die BotCommandException , um benutzerdefinierte Fehlermeldungen zurückzugeben. z. B.
//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 Einzelverantwortung
- A package ist eine Sammlung von Aktionen. Jede Aktion innerhalb eines muss package eine einzige Verantwortung haben, und diese Verantwortung muss durch diese Aktion gekapselt werden.
- Die Einhaltung des Prinzips der einheitlichen Verantwortung hilft Ihren package Verbrauchern, es einfach zu implementieren, vereinfacht Tests und vermeidet unnötige Änderungen.
- Die Aktionen, die Sie anbieten, ermöglichen package es den Verbrauchern, die Art und Weise, wie sie Ihre package innerhalb ihrer botsverwenden, anzupassen und können ihnen bots helfen, so effizient wie möglich zu sein.
- Geben Sie Beispiele an
- Bei der Einreichung packages zum fügen Bot Store Sie eine Demo bot ein, die die Verwendung des packagedemonstriert.
- Verwenden Sie die Automation 360 Aktionen, und erlauben package Sie den Kunden, diese Aktionen zu nutzen, um ihre bot Fähigkeiten aufzuwenden.
- Stellen Sie den Kunden immer bots Beschreibungen zur Verfügung, um sie package mit dem Wissen zu versorgen, das sie benötigen, um die richtige Verwendung zu verstehen.