Automatische KomponentenID in AbstractOpenemsComponent

c.lehne · November 7, 2022, 2:27pm

Wird in der Konfigurationsdatei einer beliebigen OpenEMS-Komponente keine Komponenten-ID angegeben, so wird in AbstractOpenemsComponent eine automatisch generierte Komponenten-ID erzeugt:

github.com

OpenEMS/openems/blob/08dfc3fa45e731c647967fb5157b63f3f73114d8/io.openems.edge.common/src/io/openems/edge/common/component/AbstractOpenemsComponent.java#L214


      
          	 *
          	 * @param context the OSGi ComponentContext
          	 * @param id      the unique OpenEMS Component ID
          	 * @param alias   Human-readable name of this Component. Typically
          	 *                'config.alias()'. Defaults to 'id' if empty
          	 * @param enabled is the Component enabled?
          	 */
          	private void updateContext(ComponentContext context, String id, String alias, boolean enabled) {
          		if (id == null || id.trim().isEmpty()) {
          			if (this.id == null) {
          				this.id = "_component" + AbstractOpenemsComponent.NEXT_GENERATED_COMPONENT_ID.incrementAndGet();
          			}
          		} else {
          			this.id = id;
          		}
          
          
		if (alias == null || alias.trim().isEmpty()) {
          			this.alias = this.id;
          		} else {
          			this.alias = alias;
          		}

Das erscheint mir auf den ersten Blick kontraproduktiv. Ich hätte erwartet das die Komponente während der Aktivierung eine Exception schmeißt und mich über die fehlerhafte Konfiguration informiert. Ich würde diesen Mechanismus gerne deaktivieren, vertstehe den Hintergrund aber noch nicht. Gibt es einen Grund warum die Komponenten-ID automatisch erzeugt wird?

Hintergrund meiner Frage:
Dieser Mechanismus hat bei uns dazu geführt, dass eine Edge gute 10.000 Komponenten-IDs erzeugt hat. Alle Daten wurden im Backend in die Influx-DB geschrieben und nun sehen wir uns mit einer Influx-Datenbank konfrontiert, welche gut 80.000 fields hat und nicht mehr wartbar ist. Das Problem gehört aber in ein anderes Forum ;-).

Vielen Dank,
Christian

stefan.feilmeier · November 16, 2022, 10:47am

Hallo Christian,

ja, du hast vollkommen recht, hier wäre eine Exception sinnvoller. Somit ist weiterhin sichergestellt, dass eine Komponente garantiert eine id hat.

Ich habe dafür einen Pull-Request vorbereitet:

Kannst du den PR bitte auf Github reviewen bzw. gerne auch hier Bescheid geben, ob die Lösung ok ist. Dann würde ich das mergen.

Gruß,
Stefan

c.lehne · November 17, 2022, 7:47pm

Hallo Stefan,
Code Review ist durch. Die Änderung sieht gut aus. Habe dabei gleich noch was über JUnit Tests gelernt. Ich kannte die Annotation @Test(expected = IllegalArgumentException.class) noch gar nicht. Habe Exceptions bisher immer im Test abgefangen und behandelt…

Danke! VG Christian

stefan.feilmeier · November 17, 2022, 8:59pm

Super, vielen Dank. Ich habe den PR eben gemergt.