Actualiza a Jackson 3

Author: sio2sio2

source/02.formatos/02.json/02.jackson.rst

@@ -5,14 +5,19 @@
 |YAML| es un superconjunto de |JSON| (véase una :ref:`explicación detallada del
 formato aquí <lm:yaml>`), por lo que si usamos el `proyecto Jackson
 <https://github.com/FasterXML/jackson>`_ nos es válido absolutamente todo
-:ref:`lo indicado para json <json-jackson>`. Simplemente, tendremos que cargar
+:ref:`lo indicado para JSON <json-jackson>`. Simplemente, tendremos que cargar
 `la librería adecuada
 <https://mvnrepository.com/artifact/com.fasterxml.jackson.dataformat/jackson-dataformat-yaml>`_
 y modificar la forma en que definimos el mapeador:
 
 .. code-block:: java
 
-   ObjectMapper mapper = new ObjectMapper(new YAMLFactory());
+   YamlFactory factory = YamlFactory.builder()
+      .build();
+
+   MapperBuilder<?, ?> builder = YamlMapper.builder(factory);
+
+   ObjectMapper mapper = builder.build();
 
 .. |YAML| replace:: :abbr:`YAML (YAML Ain't Markup Language)`
 .. |JSON| replace:: :abbr:`JSON (JavaScript Object Notation)`

source/02.formatos/03.yaml.rst

@@ -24,9 +24,8 @@ y esta otra ``Profesor``:
    :class: toggle
    :caption: Profesor.java
 
-.. caution:: Se ha definido el departamento como una cadena por simplificar el
-   código. En puridad, el departamento debería ser un Enum y, en ese caso,
-   habría que hacer :ref:`un traductor <json-jackson-no-primitivos>`.
+.. note:: Para no complicar en exceso el código se han puesto todos los
+   atributos como :java-lang:`String`.
 
 .. _xml-jackson-write:
 
@@ -78,20 +77,20 @@ respecto a |JSON|:
 + En |XML| el orden de los nodos elemento importa y podría ser que nos
   interesara predefinirlo.
 
-Teniendo presente esto, podemos alterar las clases anteriores del siguiente
-modo:
+Teniendo presente esto, escribamos clases abstractas complementarias que
+incluyan las anotaciones y que luego mezclaremos:
 
-.. literalinclude:: files/Claustro-xml.java
+.. literalinclude:: files/ClaustroMixin.java
    :language: java
    :class: toggle
-   :caption: Claustro.java
-   :emphasize-lines: 1,4,7,8
+   :caption: ClaustroMixin.java
+   :emphasize-lines: 1,3,6,7
 
-.. literalinclude:: files/Profesor-xml.java
+.. literalinclude:: files/ProfesorMixin.java
    :language: java
    :class: toggle
-   :caption: Profesor.java
-   :emphasize-lines: 3
+   :caption: ProfesorMixin.java
+   :emphasize-lines: 2, 5, 8
 
 Hemos utilizados anotaciones sobre las clases para:
 
@@ -130,6 +129,44 @@ Hemos utilizados anotaciones sobre las clases para:
    Por supuesto, la anotación también es válida cuando se genera el formato
    |JSON|, pero no suele tener importancia.
 
+.. note:: En este ejemplo tenemos una clase explícita (``Claustro``) que sirve
+   como envoltorio a una lista de profesores. Obśervese que es en este
+   envoltorio donde controlamos qué etiquetas se utilizan para los elementos de
+   la lista. En otro caso distinto en que
+   tuviéramos solamente una lista (o array) y quisiéramos generar un |XML|,
+   deberíamos ser conscientes de que en la traducción no podríamos controlar el
+   elemento padre ni los nombres de las etiquetas de los elementos de la lista.
+   Es decir, si tuviéramos una lista de objetos ``Profesor`` al generar un |XML|
+   obtendríamos lo siguiente:
+
+   .. code-block:: xml
+
+      <Profesor>
+         <Profesor>
+            <!-- Contenido del primer profesor... -->
+         </Profesor>
+
+         <!-- Más profesores -->
+      </Profesor>
+
+   Si nuestra intención fuera controlar los nombres de esas etiquetas al
+   traducir a XML, entonces tendríamos que crear una clase adicional que hiciera
+   de envoltorio, aunque en nuestro modelo de datos no exista:
+
+   .. code-block:: java
+
+      @JsonRootName(value = "claustro")
+      public class ProfesorWrapper {
+
+         @JacksonXmlElementWrapper(useWrapping = false)
+         @JacksonnXmlProperty(localName = "profesor")
+         private Profesor[] profesores;
+      }
+
+   Por supuesto, antes de escribir el |XML| deberíamos crear un objeto de este
+   clase envoltorio y asignar al atributo ``profesores`` la lista de profesores
+   existente.
+
 Por último queda generar la salida en el programa principal, que es básicamente
 igual que :ref:`la escritura en el caso de JSON <json-jackson-write>`:
 
@@ -145,18 +182,24 @@ igual que :ref:`la escritura en el caso de JSON <json-jackson-write>`:
        }
    );
    
-   ObjectMapper mapper = new XmlMapper()
-       .configure(ToXmlGenerator.Feature.WRITE_XML_DECLARATION, true)
-       .enable(SerializationFeature.INDENT_OUTPUT);   // Salida "bonita".
+   XmlFactory factory = XmLFactory.builder()
+      .enable(XmlWriteFeature.WRITE_XML_DECLARATION)
+      .enable(XmlWriteFeature.WRITE_XML_1_1)
+      .build();
+
+   MapperBuilder<?, ?> builder = XmlFactory.builder(factory)
+      .enable(SerializationFeature.INDENT_OUTPUT)
+      .addMixIn(Claustro.class, ClaustroMixin.class)
+      .addMixIn(Profesor.class, ProfesorMixin.class);
+
+   ObjectMapper mapper = builder.build();
 
    try (
        OutputStream st = Files.newOutputStream(archivo);
        OutputStreamWriter sw = new OutputStreamWriter(st);
-   )
-   {
+   ) {
        mapper.writeValue(sw, claustro);
-   }
-   catch(IOException err) {
+   } catch(IOException err) {
        err.printStackTrace();
    }
    
@@ -168,8 +211,7 @@ También podríamos haber generado una cadena con la salida:
    try {
        String contenido = mapper.writeValueAsString(claustro);
        System.out.println(contenido);
-   }
-   catch(IOException err) {
+   } catch(IOException err) {
        err.printStackTrace();
    }
 
@@ -189,19 +231,22 @@ Habiendo definido las clases con anotaciones como en el apartado anterior, la
 lectura del formato es :ref:`prácticamente la misma que para JSON <json-jackson-read>`:
 
 .. code-block:: java
-   :emphasize-lines: 2
 
    Path archivo = Path.of(System.getProperty("user.home"), "claustro.xml");
-   ObjectMapper mapper = new XmlMapper();
+   
+   MapperBuilder<?, ?> builder = XmlFactory.builder()
+      .addMixIn(Claustro.class, ClaustroMixin.class)
+      .addMixIn(Profesor.class, ProfesorMixin.class);
+
+   ObjectMapper mapper = builder.build();
 
    try (
       InputStream st = Files.newInputStream(ruta);
       InputStreamReader sr = new InputStreamReader(st);
    ) {
       Claustro claustro = mapper.readValue(sr, Claustro.class);
       System.out.println(claustro);
-   }
-   catch(IOException err) {
+   } catch(IOException err) {
       err.printStackTrace();
    }
 

source/03.xml/02.jackson.rst

@@ -10,10 +10,21 @@ public Claustro(String centro, Profesor[] plantilla) {
         setPlantilla(plantilla);
     }
 
-    public String getCentro() { return centro; }
-    public void setCentro(String centro) { this.centro = centro; }
-    public Profesor[] getPlantilla() { return plantilla; }
-    public void setPlantilla(Profesor[] plantilla) { this.plantilla = plantilla; }
+    public String getCentro() {
+       return centro;
+    }
+
+    public void setCentro(String centro) {
+       this.centro = centro;
+    }
+
+    public Profesor[] getPlantilla() {
+       return plantilla;
+    }
+
+    public void setPlantilla(Profesor[] plantilla) {
+       this.plantilla = plantilla;
+    }
 
     public String toString() {
         return String.format("%s -- %s", centro, Arrays.toString(plantilla));

source/03.xml/files/Claustro-xml.java

@@ -0,0 +1,9 @@
+@JsonRootName(value = "claustro")
+public class ClaustroMixin {
+    @JacksonXmlProperty(isAttribute = true)
+    private String centro;
+
+    @JacksonXmlElementWrapper(useWrapping = false)
+    @JacksonXmlProperty(localName = "profesor")
+    private Profesor[] plantilla;
+}

source/03.xml/files/Claustro.java

@@ -11,7 +11,6 @@ public class Profesor {
 
     public Profesor() {}
 
-    // Deberíamos tratar "casillero" y "sustituye"...
     public Profesor(String id, String apelativo, String nombre, String apellidos, String departamento, String nacimiento) {
         setId(id);
         setApelativo(apelativo);
@@ -20,20 +19,59 @@ public Profesor(String id, String apelativo, String nombre, String apellidos, St
         setDepartamento(departamento);
     }
 
-    public String getId() { return id; }
-    public void setId(String id) { this.id = id; }
-    public String getSustituye() { return sustituye; }
-    public void setSustituye(String sustituye) { this.sustituye = sustituye; }
-    public String getCasillero() { return casillero; }
-    public void setCasillero(String casillero) { this.casillero = casillero; }
-    public String getApelativo() { return apelativo; }
-    public void setApelativo(String apelativo) { this.apelativo = apelativo; }
-    public String getNombre() { return nombre; }
-    public void setNombre(String nombre) { this.nombre = nombre; }
-    public String getApellidos() { return apellidos; }
-    public void setApellidos(String apellidos) { this.apellidos = apellidos; }
-    public String getDepartamento() { return departamento; }
-    public void setDepartamento(String departamento) { this.departamento = departamento; }
+    public String getId() { 
+       return id;
+    }
+
+    public void setId(String id) {
+       this.id = id;
+    }
+
+    public String getSustituye() {
+       return sustituye;
+    }
+
+    public void setSustituye(String sustituye) {
+       this.sustituye = sustituye;
+    }
+
+    public String getCasillero() {
+       return casillero;
+    }
+
+    public void setCasillero(String casillero) {
+       this.casillero = casillero;
+    }
+
+    public String getApelativo() {
+       return apelativo;
+    }
+    public void setApelativo(String apelativo) {
+       this.apelativo = apelativo;
+    }
+    public String getNombre() {
+       return nombre;
+    }
+
+    public void setNombre(String nombre) {
+       this.nombre = nombre;
+    }
+
+    public String getApellidos() {
+       return apellidos;
+    }
+
+    public void setApellidos(String apellidos) {
+       this.apellidos = apellidos;
+    }
+
+    public String getDepartamento() {
+       return departamento;
+    }
+
+    public void setDepartamento(String departamento) {
+       this.departamento = departamento;
+    }
 
     public String toString() {
         return String.format("%s, %s [%s] (%s)", apellidos, nombre, id, departamento);

source/03.xml/files/ClaustroMixin.java

@@ -0,0 +1,10 @@
+public abstract class ProfesorMixin {
+    @JacksonXmlProperty(isAttribute = true)
+    private String id;
+
+    @JacksonXmlProperty(isAttribute = true)
+    private String sustituye;
+
+    @JacksonXmlProperty(isAttribute = true)
+    private String casillero;
+}

source/03.xml/files/Profesor-xml.java

@@ -40,6 +40,9 @@ Archivos
       + Fecha de nacimiento.
       + Estudios previos (Sin estudios, Primaria, Secundaria, Bachillerato, FP, Universidad).
 
+      Haga una interfaz interactiva y otra que tome datos incluidos en el propio
+      código.
+
    b. Guarde la lista de estudiantes en un archivo.
    c. Recupere el archivo y compruebe que la lista recuperada es igual a la
       lista original. Para esto último, implemente un método ``equals`` que