diff --git a/content/news/2025-11-15-mapstruct-spring-extensions-2-0-0-released.md b/content/news/2025-11-15-mapstruct-spring-extensions-2-0-0-released.md new file mode 100644 index 000000000..3371e66d8 --- /dev/null +++ b/content/news/2025-11-15-mapstruct-spring-extensions-2-0-0-released.md @@ -0,0 +1,60 @@ +--- +title: "MapStruct Spring Extensions 2.0.0 released" +author: Raimund Klein +date: "2025-11-15" +tags: [ release, news ] +--- + +It is my pleasure to announce the next official release of MapStruct Spring Extensions. +What started out as a [StackOverflow question](https://stackoverflow.com/q/58081224/3361467) turned into its +own [(sub-)project](https://github.com/mapstruct/mapstruct-spring-extensions) within the MapStruct organization. + +Changes in this release: + +- The minimum requirements for applying these extensions are now Java 17 and Spring 6. +- Exclusive use of `jakarta.annotation.PostConstruct` instead of having a default option of the legacy `javax.annotation.PostConstruct`. + +Including the annotations and extensions defined in this project will generate a class acting as bridge between +MapStruct's conventions and Spring' +s [ConversionService API](https://docs.spring.io/spring-framework/docs/current/reference/html/core.html#core-convert-ConversionService-API) +that in turn can be added to any Mapper's `uses` attribute. See +the [examples](https://github.com/mapstruct/mapstruct-spring-extensions/tree/master/examples) for details. + + + +### Thanks + +Thanks to [Sjaak Derksen](https://github.com/sjaakd) for suggesting this solution +and [Filip Hrisafov](https://github.com/filiphr) for opening the community project. +Also thanks +to [Jeff Schnitzer](https://github.com/stickfigure), [Jesse Bonzo](https://github.com/jbonzohln), [Cosimo Damiano Prete](https://github.com/cdprete), [Daniel Shiplett](https://github.com/danielshiplett), [Alexey](https://github.com/PRIESt512), [Olivier Boudet](https://github.com/olivierboudet), [John Kelly](https://github.com/postalservice14), [Myat Min](https://github.com/myatmin), [Hypercube Software](https://github.com/hypercube-software), [coding-guo](https://github.com/coding-guo), [freund17](https://github.com/freund17), [Joose Haverinen](https://github.com/joosehav), [pw-lehre](https://github.com/pw-lehre), [simonovdenis](https://github.com/simonovdenis), +and [George Noble](https://github.com/giorgioscia) for their suggestions and fixes in previous releases. +If you feel like there's something missing in MapStruct which could make the Spring experience any smoother, please get +involved! + +Also, if your favourite library or framework could use some tweaking with regard to MapStruct, contact us. + +Happy coding with MapStruct Spring Extensions! + +### Download + +You can fetch the release from Maven Central using the following GAV coordinates: + +* Annotation + JAR: [org.mapstruct.extensions.spring:mapstruct-spring-annotations:2.0.0](http://search.maven.org/#artifactdetails|org.mapstruct.extensions.spring|mapstruct-spring-annotations|2.0.0|jar) +* Annotation processor + JAR: [org.mapstruct.extensions.spring:mapstruct-spring-extensions:2.0.0](http://search.maven.org/#artifactdetails|org.mapstruct.extensions.spring|mapstruct-spring-extensions|2.0.0|jar) +* Test Extensions with Converter Scan + JAR: [org.mapstruct.extensions.spring:mapstruct-spring-extensions:2.0.0](http://search.maven.org/#artifactdetails|org.mapstruct.extensions.spring|mapstruct-spring-test-extensions|2.0.0|jar) + +Alternatively, you can get ZIP and TAR.GZ distribution bundles - containing all the JARs, documentation +etc. - [from GitHub](https://github.com/mapstruct/mapstruct-spring-extensions/releases/tag/v2.0.0). + +If you run into any trouble or would like to report a bug, feature request or similar, use the following channels to get +in touch: + +* Get help in our [Gitter room](https://gitter.im/mapstruct/mapstruct-users) or at + the [mapstruct-users](https://groups.google.com/forum/?fromgroups#!forum/mapstruct-users) group +* Report bugs and feature requests via + the [issue tracker](https://github.com/mapstruct/mapstruct-spring-extensions/issues) +* Follow [@GetMapStruct](https://twitter.com/GetMapStruct) on Twitter diff --git a/data/releases/spring-extensions.toml b/data/releases/spring-extensions.toml index fedc12dc5..d50f3b963 100644 --- a/data/releases/spring-extensions.toml +++ b/data/releases/spring-extensions.toml @@ -1,5 +1,5 @@ name = "Spring Extensions" versionRef = "spring-extensions" order = 450 -releaseDate = 2025-03-14 +releaseDate = 2025-11-15 spring = true diff --git a/static/documentation/spring-extensions/api/annotations/allclasses-index.html b/static/documentation/spring-extensions/api/annotations/allclasses-index.html index 25ceb54bc..09bbcfc97 100644 --- a/static/documentation/spring-extensions/api/annotations/allclasses-index.html +++ b/static/documentation/spring-extensions/api/annotations/allclasses-index.html @@ -1,182 +1,80 @@ - - -All Classes (annotations 1.1.3 API) + +All Classes and Interfaces (annotations 2.0.0 API) + + + - + - - - - - + + - - -
+
+ +
-

All Classes

+

All Classes and Interfaces

-
- +
+
- diff --git a/static/documentation/spring-extensions/api/annotations/allclasses.html b/static/documentation/spring-extensions/api/annotations/allclasses.html deleted file mode 100644 index 599d11368..000000000 --- a/static/documentation/spring-extensions/api/annotations/allclasses.html +++ /dev/null @@ -1,33 +0,0 @@ - - - - - -All Classes (annotations 1.1.3 API) - - - - - - - - - - - - -
-

All Classes

-
- -
-
- - diff --git a/static/documentation/spring-extensions/api/annotations/allpackages-index.html b/static/documentation/spring-extensions/api/annotations/allpackages-index.html index dcc021d33..c261faf1a 100644 --- a/static/documentation/spring-extensions/api/annotations/allpackages-index.html +++ b/static/documentation/spring-extensions/api/annotations/allpackages-index.html @@ -1,162 +1,62 @@ - - -All Packages (annotations 1.1.3 API) + +All Packages (annotations 2.0.0 API) + + + - + - - - - - + + - - -
+
+ +

All Packages

-
- +
Package Summary
+
+
Package
+
Description
+
org.mapstruct.extensions.spring
+
 
-
- -
diff --git a/static/documentation/spring-extensions/api/annotations/constant-values.html b/static/documentation/spring-extensions/api/annotations/constant-values.html index 228942316..d9c55eabb 100644 --- a/static/documentation/spring-extensions/api/annotations/constant-values.html +++ b/static/documentation/spring-extensions/api/annotations/constant-values.html @@ -1,191 +1,83 @@ - - -Constant Field Values (annotations 1.1.3 API) + +Constant Field Values (annotations 2.0.0 API) + + + - + - - - - - + + - - -
+
+ +

Constant Field Values

-
+

Contents

-
- - -
+

org.mapstruct.*

-
-
-
- -
diff --git a/static/documentation/spring-extensions/api/annotations/deprecated-list.html b/static/documentation/spring-extensions/api/annotations/deprecated-list.html deleted file mode 100644 index f43479653..000000000 --- a/static/documentation/spring-extensions/api/annotations/deprecated-list.html +++ /dev/null @@ -1,144 +0,0 @@ - - - - - -Deprecated List (annotations 1.1.3 API) - - - - - - - - - - - - - - -
- -
-
-
-

Deprecated API

-

Contents

-
-
-
- -
- - diff --git a/static/documentation/spring-extensions/api/annotations/help-doc.html b/static/documentation/spring-extensions/api/annotations/help-doc.html index be9bd52ab..341624831 100644 --- a/static/documentation/spring-extensions/api/annotations/help-doc.html +++ b/static/documentation/spring-extensions/api/annotations/help-doc.html @@ -1,121 +1,112 @@ - - -API Help (annotations 1.1.3 API) + +API Help (annotations 2.0.0 API) + + + - + - - - - - + + - - -
+
+ +
-
-

How This API Document Is Organized

-
This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
+

JavaDoc Help

+ +
+
+

Navigation

+Starting from the Overview page, you can browse the documentation using the links in each page, and in the navigation bar at the top of each page. The Index and Search box allow you to navigate to specific declarations and summary pages, including: All Packages, All Classes and Interfaces +
-
-
    -
  • -
    -

    Package

    -

    Each package has a page that contains a list of its classes and interfaces, with a summary for each. These pages may contain six categories:

    -
      +
      +
      +

      Kinds of Pages

      +The following sections describe the different kinds of pages in this collection. +
      +

      Package

      +

      Each package has a page that contains a list of its classes and interfaces, with a summary for each. These pages may contain the following categories:

      +
      • Interfaces
      • Classes
        • -
      • Enums
        • +
      • Enum Classes
      • Exceptions
      • Errors
        • -
      • Annotation Types
        • +
      • Annotation Interfaces
      - -
    • -
      -

      Class or Interface

      -

      Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a class/interface description, summary tables, and detailed member descriptions:

      -
        +
        +

        Class or Interface

        +

        Each class, interface, nested class and nested interface has its own separate page. Each of these pages has three sections consisting of a declaration and description, member summary tables, and detailed member descriptions. Entries in each of these sections are omitted if they are empty or not applicable.

        +
        • Class Inheritance Diagram
        • Direct Subclasses
        • All Known Subinterfaces
          • @@ -124,141 +115,60 @@

          Class or Interface

        • Class or Interface Description

        -
          +
          • Nested Class Summary
            • +
          • Enum Constant Summary
          • Field Summary
          • Property Summary
          • Constructor Summary
          • Method Summary
            • -
          -
          -
            -
          • Field Detail
            • -
          • Property Detail
            • -
          • Constructor Detail
            • -
          • Method Detail
            • -
          -

          Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.

          -
        - -
      • -
        -

        Annotation Type

        -

        Each annotation type has its own separate page with the following sections:

        -
          -
        • Annotation Type Declaration
          • -
        • Annotation Type Description
        • Required Element Summary
        • Optional Element Summary
          • -
        • Element Detail
        -
        -
        • -
      • -
        -

        Enum

        -

        Each enum has its own separate page with the following sections:

        -
          -
        • Enum Declaration
          • -
        • Enum Description
          • -
        • Enum Constant Summary
          • -
        • Enum Constant Detail
          • +
          +
            +
          • Enum Constant Details
            • +
          • Field Details
            • +
          • Property Details
            • +
          • Constructor Details
            • +
          • Method Details
            • +
          • Element Details
          +

          Note: Annotation interfaces have required and optional elements, but not methods. Only enum classes have enum constants. The components of a record class are displayed as part of the declaration of the record class. Properties are a feature of JavaFX.

          +

          The summary entries are alphabetical, while the detailed descriptions are in the order they appear in the source code. This preserves the logical groupings established by the programmer.

        -
        • -
      • -
        -

        Tree (Class Hierarchy)

        +
        +

        Other Files

        +

        Packages and modules may contain pages with additional information related to the declarations nearby.

        +
        +
        +

        Tree (Class Hierarchy)

        There is a Class Hierarchy page for all packages, plus a hierarchy for each package. Each hierarchy page contains a list of classes and a list of interfaces. Classes are organized by inheritance structure starting with java.lang.Object. Interfaces do not inherit from java.lang.Object.

        -
          -
        • When viewing the Overview page, clicking on "Tree" displays the hierarchy for all packages.
          • -
        • When viewing a particular package, class or interface page, clicking on "Tree" displays the hierarchy for only that package.
          • +
            +
          • When viewing the Overview page, clicking on TREE displays the hierarchy for all packages.
            • +
          • When viewing a particular package, class or interface page, clicking on TREE displays the hierarchy for only that package.
        -
        • -
      • -
        -

        Deprecated API

        -

        The Deprecated API page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.

        -
        -
        • -
      • -
        -

        Index

        -

        The Index contains an alphabetic index of all classes, interfaces, constructors, methods, and fields, as well as lists of all packages and all classes.

        -
        -
        • -
      • -
        -

        All Classes

        -

        The All Classes link shows all classes and interfaces except non-static nested types.

        +
        +

        Constant Field Values

        +

        The Constant Field Values page lists the static final fields and their values.

        -
        • -
      • -
        -

        Serialized Form

        -

        Each serializable or externalizable class has a description of its serialization fields and methods. This information is of interest to re-implementors, not to developers using the API. While there is no link in the navigation bar, you can get to this information by going to any serialized class and clicking "Serialized Form" in the "See also" section of the class description.

        +
        +

        All Packages

        +

        The All Packages page contains an alphabetic index of all packages contained in the documentation.

        -
        • -
      • -
        -

        Constant Field Values

        -

        The Constant Field Values page lists the static final fields and their values.

        +
        +

        All Classes and Interfaces

        +

        The All Classes and Interfaces page contains an alphabetic index of all classes and interfaces contained in the documentation, including annotation interfaces, enum classes, and record classes.

        -
        • -
      • -
        -

        Search

        -

        You can search for definitions of modules, packages, types, fields, methods and other terms defined in the API, using some or all of the name. "Camel-case" abbreviations are supported: for example, "InpStr" will find "InputStream" and "InputStreamReader".

        +
        +

        Index

        +

        The Index contains an alphabetic index of all classes, interfaces, constructors, methods, and fields in the documentation, as well as summary pages such as All Packages, All Classes and Interfaces.

        -
        • -
      +
      • -This help file applies to API documentation generated by the standard doclet.
-
-
- -
diff --git a/static/documentation/spring-extensions/api/annotations/index-all.html b/static/documentation/spring-extensions/api/annotations/index-all.html index 838f49950..9fe5359ad 100644 --- a/static/documentation/spring-extensions/api/annotations/index-all.html +++ b/static/documentation/spring-extensions/api/annotations/index-all.html @@ -1,269 +1,154 @@ - - -Index (annotations 1.1.3 API) + +Index (annotations 2.0.0 API) + + + - + - - - - - + + - - -
+
+ +
-
A C D E G L O S T V 
All Classes All Packages - - -

A

-
-
adapterMethodName() - Method in annotation type org.mapstruct.extensions.spring.ExternalConversion
+
+

Index

+
+A C D E G L O S T V 
All Classes and Interfaces|All Packages|Constant Field Values +

A

+
+
adapterMethodName() - Element in annotation interface org.mapstruct.extensions.spring.ExternalConversion
 
-
AdapterMethodName - Annotation Type in org.mapstruct.extensions.spring
+
AdapterMethodName - Annotation Interface in org.mapstruct.extensions.spring
Overrides the default method name generated in the Adapter class.
- - - -

C

-
-
conversionServiceAdapterClassName() - Method in annotation type org.mapstruct.extensions.spring.SpringMapperConfig
+

C

+
+
conversionServiceAdapterClassName() - Element in annotation interface org.mapstruct.extensions.spring.SpringMapperConfig
-
The class name for the generated Adapter between the MapStruct mappers and Spring's ConversionService.
+
The class name for the generated Adapter between the MapStruct mappers and Spring's ConversionService.
-
conversionServiceAdapterPackage() - Method in annotation type org.mapstruct.extensions.spring.SpringMapperConfig
+
conversionServiceAdapterPackage() - Element in annotation interface org.mapstruct.extensions.spring.SpringMapperConfig
-
The package name for the generated Adapter between the MapStruct mappers and Spring's ConversionService.
+
The package name for the generated Adapter between the MapStruct mappers and Spring's ConversionService.
-
conversionServiceBeanName() - Method in annotation type org.mapstruct.extensions.spring.SpringMapperConfig
+
conversionServiceBeanName() - Element in annotation interface org.mapstruct.extensions.spring.SpringMapperConfig
-
The bean name for the Spring ConversionService to use.
+
The bean name for the Spring ConversionService to use.
-
converterRegistrationConfigurationClassName() - Method in annotation type org.mapstruct.extensions.spring.SpringMapperConfig
+
converterRegistrationConfigurationClassName() - Element in annotation interface org.mapstruct.extensions.spring.SpringMapperConfig
The class name for the generated Configuration class, which is performing auto-registration of converters/mappers - to Spring's ConversionService.
+ to Spring's ConversionService.
- - - -

D

-
-
DEFAULT_ADAPTER_CLASS_NAME - Static variable in annotation type org.mapstruct.extensions.spring.SpringMapperConfig
+

D

+
+
DEFAULT_ADAPTER_CLASS_NAME - Static variable in annotation interface org.mapstruct.extensions.spring.SpringMapperConfig
 
-
DEFAULT_CONFIGURATION_CLASS_NAME - Static variable in annotation type org.mapstruct.extensions.spring.SpringMapperConfig
+
DEFAULT_CONFIGURATION_CLASS_NAME - Static variable in annotation interface org.mapstruct.extensions.spring.SpringMapperConfig
 
-
DEFAULT_CONVERSION_SERVICE_BEAN_NAME - Static variable in annotation type org.mapstruct.extensions.spring.SpringMapperConfig
+
DEFAULT_CONVERSION_SERVICE_BEAN_NAME - Static variable in annotation interface org.mapstruct.extensions.spring.SpringMapperConfig
 
-
DelegatingConverter - Annotation Type in org.mapstruct.extensions.spring
+
DelegatingConverter - Annotation Interface in org.mapstruct.extensions.spring
-
Indicates that the system should generate a delegating Converter that will call the annotated method in its - own Converter.convert(Object).
+
Indicates that the system should generate a delegating Converter that will call the annotated method in its + own Converter.convert(Object).
- - - -

E

-
-
ExternalConversion - Annotation Type in org.mapstruct.extensions.spring
+

E

+
+
ExternalConversion - Annotation Interface in org.mapstruct.extensions.spring
-
Allows the specification of a conversion that is available via the ConversionService, but is not - declared as a MapStruct mapper within the scope of the SpringMapperConfig.
+
Allows the specification of a conversion that is available via the ConversionService, but is not + declared as a MapStruct mapper within the scope of the SpringMapperConfig.
-
externalConversions() - Method in annotation type org.mapstruct.extensions.spring.SpringMapperConfig
+
externalConversions() - Element in annotation interface org.mapstruct.extensions.spring.SpringMapperConfig
-
Additional conversions which should be made available through the +
Additional conversions which should be made available through the generated Adapter.
- - - -

G

-
-
generateConverterScan() - Method in annotation type org.mapstruct.extensions.spring.SpringMapperConfig
+

G

+
+
generateConverterScan() - Element in annotation interface org.mapstruct.extensions.spring.SpringMapperConfig
Indicates whether to generate a ConverterScan when using conversionServiceBeanName().
- - - -

L

-
-
lazyAnnotatedConversionServiceBean() - Method in annotation type org.mapstruct.extensions.spring.SpringMapperConfig
+

L

+
+
lazyAnnotatedConversionServiceBean() - Element in annotation interface org.mapstruct.extensions.spring.SpringMapperConfig
To set if the Lazy annotation will be added to the ConversionService's usage in the ConversionServiceAdapter.
- - - -

O

-
+

O

+
org.mapstruct.extensions.spring - package org.mapstruct.extensions.spring
 
- - - -

S

-
-
sourceType() - Method in annotation type org.mapstruct.extensions.spring.ExternalConversion
+

S

+
+
sourceType() - Element in annotation interface org.mapstruct.extensions.spring.ExternalConversion
 
-
SpringMapperConfig - Annotation Type in org.mapstruct.extensions.spring
+
SpringMapperConfig - Annotation Interface in org.mapstruct.extensions.spring
Marks a class or interface as configuration source for the Spring extension.
- - - -

T

-
-
targetType() - Method in annotation type org.mapstruct.extensions.spring.ExternalConversion
+

T

+
+
targetType() - Element in annotation interface org.mapstruct.extensions.spring.ExternalConversion
 
- - - -

V

-
-
value() - Method in annotation type org.mapstruct.extensions.spring.AdapterMethodName
+

V

+
+
value() - Element in annotation interface org.mapstruct.extensions.spring.AdapterMethodName
The method name to be used instead of the default.
-A C D E G L O S T V 
All Classes All Packages
- - diff --git a/static/documentation/spring-extensions/api/annotations/index.html b/static/documentation/spring-extensions/api/annotations/index.html index 9581c2073..57b04cb9f 100644 --- a/static/documentation/spring-extensions/api/annotations/index.html +++ b/static/documentation/spring-extensions/api/annotations/index.html @@ -1,18 +1,20 @@ - - -annotations 1.1.3 API + +annotations 2.0.0 API + + + + + - - - +