Hacktoberfest 2026: le issue che i maintainer hanno segnato per ottobre, aperte e adatte ai principianti. Sfoglia le issue Hacktoberfest

Partial serialization

Aperta
  • Qualcosa non va?
#838 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
38/100
Tipo di issue
Funzionalità
Chiarezza
Abbastanza chiara
Stato di attività
Tranquilla
Stack tecnologico
java
Ambito
backend-api-design

Direzione di ricerca

Inizia tracciando la creazione di ObjectMapper e la registrazione dei serializer personalizzati in AbstractBomGenerator, nelle sue implementazioni e nelle implementazioni di Parser. Esamina come sono attualmente configurate la serializzazione e la deserializzazione per ogni Version, quindi definisci il comportamento dell’accessor pubblico e del caching. L’attività è completata quando gli oggetti BOM parziali possono utilizzare lo stesso mapper configurato e i cicli ripetuti sui documenti non creano istanze ridondanti di ObjectMapper.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

Currently the AbstractBomGenerator and it's implementations use several custom serializers, which are registered in an always new ObjectMapper.

Handling partial serialization of a BOM is not cleanly possible (e.g. serializing a single vulnerability or a list of components), since the ObjectMapper is not exposed and the AbstractBomGenerator signatures do not match. The only way of achieving this, while serializing exactly as this reference implementation is either using reflection hacks or by full on copy pasting the code.

Additionally, the Jackson ObjectMapper isn't a lightweight object. For a simple parse-modify-writeback loop of a cyclonedx document two separate ObjectMappers are created on every such loop, which is fully unnecessary.

Feature request / proposal:

  • Decouple ObjectMapper creation and configuration from AbstractBomGenerator and Parser implementations
  • Expose the ObjectMapper in a public accessor
  • While at it, memorize/cache the ObjectMapper instance per Version, so that a single instance of an ObjectMapper is used for serialization and deserialization

Benefits of the change:

  • enables partial serialization of BOMs and cleanly working directly with document parts.
  • reduces / stabilizes memory footprint when (de-)serializing multiple documents
  • improves performance when (de-)serializing from the second document onward (when the ObjectMapper has been created)

Context of this request:
I'm currently working on a private project (private for now, currently too raw / alpha) which stores and queries CycloneDX. I'm heavily using Postgres JSONB support, and being able to properly work with partial objects is a requirement for me.

Is there interest in a feature like that? I'll build that for myself anyway, but having it integrated in the core lib would be cleaner for me, and might benefit a few other people, so I gladly can make a PR.
Just wanted to ask before dropping a rather big change out of the blue.

Lingua principale
Java
Stelle
122
Fork
92
Merge medio
1g 11h
PR unite (30g)
36

Preparare l'ambiente

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di CycloneDX/cyclonedx-core-java

Tutte le issue di CycloneDX/cyclonedx-core-java

Issue simili

Altre issue su Java

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.