Convert over to use MapStruct

bevans2000 · bevans2000 · commit d6d1d28f03f9 · 2022-09-30T17:42:28.000+01:00
diff --git a/README.md b/README.md
@@ -1,12 +1,12 @@
 # Mars Sim REST Pilot
 
-This project is a simple SpringBoot RestAPI server to prototype an API for the mars-sim project to support a REactJS client.
+This project is a simple SpringBoot RestAPI server to prototype an API for the mars-sim project to support a ReactJS client.
 
 ## Projects
 There are 2 sub-projects:
 
 ### Rest-server
-A Spring boot Java app that provides a RestAPI of entities. It uses the [ModelMapper](http://modelmapper.org/) to automatically provide the mapping code from the model objects to the various DTO equivalents. There is a _model_ package that emulates the model objects of the Simulation.
+A Spring boot Java app that provides a RestAPI of entities. It uses the [MapStruct](https://mapstruct.org) to automatically generate the mapping code from the model objects to the various DTO equivalents. There is a _model_ package that emulates the model objects of the Simulation. The package _dto_ contains the DTO exposed to the client. The _mapper_ package contains the Mappers that define any custom mappings needed for the DTOs. MapStruct has a default mapping logic but it can be overridden.
 
 The Rest API is exposed under the _/api_ endpoint and follows the standard approach of entity & idenfitier as URL paths. Filters applied as request parameters.
 
diff --git a/rest-server/pom.xml b/rest-server/pom.xml
@@ -14,9 +14,11 @@
 	<properties>
 		<java.version>11</java.version>
 		<maven.compiler.release>11</maven.compiler.release>
-        <modelmapper.version>3.0.0</modelmapper.version>
 		<openapi.version>1.6.4</openapi.version>
 		<springboot.version>2.6.3</springboot.version>
+		<lombok.version>1.18.16</lombok.version>
+		<mapstruct.version>1.5.2.Final</mapstruct.version>
+		<lombok-binding.version>0.2.0</lombok-binding.version>
 		<mainClass>org.mars_sim.rest.App</mainClass>	
 	</properties>
 	<dependencyManagement>
@@ -50,9 +52,9 @@
 			<artifactId>spring-boot-starter-actuator</artifactId>
 		</dependency>
 		<dependency>
-			<groupId>org.modelmapper</groupId>
-			<artifactId>modelmapper</artifactId>
-			<version>${modelmapper.version}</version>
+			<groupId>org.mapstruct</groupId>
+			<artifactId>mapstruct</artifactId>
+			<version>${mapstruct.version}</version> 
 		</dependency>
 		<dependency>
 			<groupId>org.springdoc</groupId>
@@ -62,7 +64,8 @@
 		<dependency>
 			<groupId>org.projectlombok</groupId>
 			<artifactId>lombok</artifactId>
-			<optional>true</optional>
+			<version>${lombok.version}</version>
+			<scope>provided</scope>
 		</dependency>
 		<dependency>
 			<groupId>org.springframework.boot</groupId>
@@ -79,6 +82,23 @@
 				<version>3.8.0</version>
 				<configuration>
 					<release>11</release>
+					<annotationProcessorPaths>
+						<path>
+							<groupId>org.mapstruct</groupId>
+							<artifactId>mapstruct-processor</artifactId>
+							<version>${mapstruct.version}</version>
+						</path>
+						<path>
+							<groupId>org.projectlombok</groupId>
+							<artifactId>lombok</artifactId>
+							<version>${lombok.version}</version>
+						</path>
+						<path>
+							<groupId>org.projectlombok</groupId>
+							<artifactId>lombok-mapstruct-binding</artifactId>
+							<version>${lombok-binding.version}</version>
+						</path>
+					</annotationProcessorPaths>
 				</configuration>
 			</plugin>
 			<plugin>
diff --git a/rest-server/src/main/java/org/mars_sim/rest/App.java b/rest-server/src/main/java/org/mars_sim/rest/App.java
@@ -1,7 +1,6 @@
 package org.mars_sim.rest;
 
 import org.mars_sim.rest.model.Simulation;
-import org.modelmapper.ModelMapper;
 import org.springframework.boot.ApplicationArguments;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
@@ -18,10 +17,4 @@ public Simulation getSimulation(ApplicationArguments args) {
         System.out.println("Commandline args = " + args);
         return new Simulation();
     }
-
-    @Bean
-    public ModelMapper getModelMapper() {
-        ModelMapper mapper = new ModelMapper();
-        return mapper;
-    }
 }
diff --git a/rest-server/src/main/java/org/mars_sim/rest/controller/PersonController.java b/rest-server/src/main/java/org/mars_sim/rest/controller/PersonController.java
@@ -4,11 +4,12 @@
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
+import org.mapstruct.factory.Mappers;
 import org.mars_sim.rest.dto.PersonDTO;
 import org.mars_sim.rest.dto.PersonSummaryDTO;
+import org.mars_sim.rest.mapper.PersonMapper;
 import org.mars_sim.rest.model.Person;
 import org.mars_sim.rest.model.Simulation;
-import org.modelmapper.ModelMapper;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PathVariable;
@@ -23,8 +24,7 @@ public class PersonController {
     @Autowired
     private Simulation sim;
 
-    @Autowired
-    private ModelMapper mapper;
+    private PersonMapper mapper = Mappers.getMapper(PersonMapper.class);
 
     @GetMapping("")
     List<PersonSummaryDTO> getPersons(@RequestParam(required=false) Integer settlementId) {
@@ -35,12 +35,12 @@ List<PersonSummaryDTO> getPersons(@RequestParam(required=false) Integer settleme
         else {
             found = sim.getPersons().stream();
         }
-        return found.map(s -> mapper.map(s, PersonSummaryDTO.class)).collect(Collectors.toList());
+        return found.map(s -> mapper.toSummary(s)).collect(Collectors.toList());
     }
 
     @GetMapping("/{id}")
     public PersonDTO getPerson(@PathVariable int id) {
         Person s = sim.getPersons().get(id-1);
-        return mapper.map(s, PersonDTO.class);
+        return mapper.toFull(s);
     }
 }
diff --git a/rest-server/src/main/java/org/mars_sim/rest/controller/SettlementController.java b/rest-server/src/main/java/org/mars_sim/rest/controller/SettlementController.java
@@ -3,11 +3,12 @@
 import java.util.List;
 import java.util.stream.Collectors;
 
+import org.mapstruct.factory.Mappers;
 import org.mars_sim.rest.dto.SettlementDTO;
 import org.mars_sim.rest.dto.SettlementSummaryDTO;
+import org.mars_sim.rest.mapper.SettlementMapper;
 import org.mars_sim.rest.model.Settlement;
 import org.mars_sim.rest.model.Simulation;
-import org.modelmapper.ModelMapper;
 import org.springframework.beans.factory.annotation.Autowired;
 import org.springframework.web.bind.annotation.GetMapping;
 import org.springframework.web.bind.annotation.PathVariable;
@@ -21,17 +22,16 @@ public class SettlementController {
     @Autowired
     private Simulation sim;
 
-    @Autowired
-    private ModelMapper mapper;
+    private SettlementMapper mapper = Mappers.getMapper(SettlementMapper.class);
 
     @GetMapping("")
     List<SettlementSummaryDTO> getSettlements() {
-        return sim.getSettlements().stream().map(s -> mapper.map(s, SettlementSummaryDTO.class)).collect(Collectors.toList());
+        return sim.getSettlements().stream().map(s -> mapper.toSummary(s)).collect(Collectors.toList());
     }
 
     @GetMapping("/{id}")
     public SettlementDTO getSettlement(@PathVariable int id) {
         Settlement s = sim.getSettlements().get(id-1);
-        return mapper.map(s, SettlementDTO.class);
+        return mapper.toFull(s);
     }
 }
diff --git a/rest-server/src/main/java/org/mars_sim/rest/dto/PersonDTO.java b/rest-server/src/main/java/org/mars_sim/rest/dto/PersonDTO.java
@@ -5,6 +5,9 @@
 
 @Getter @Setter 
 public class PersonDTO extends PersonSummaryDTO {
+ 
     private ReferencableDTO settlement; 
+    
+
     private ReportingAuthorityDTO authority; 
 }
diff --git a/rest-server/src/main/java/org/mars_sim/rest/dto/PersonSummaryDTO.java b/rest-server/src/main/java/org/mars_sim/rest/dto/PersonSummaryDTO.java
@@ -12,8 +12,10 @@ public class PersonSummaryDTO extends ReferencableDTO {
    private String role; 
    private String gender; 
    private String building; 
+
    private String conditionHealth; 
    private float conditionPerformance;
    private float conditionEnergy;
+   
    private String task;  
 }
diff --git a/rest-server/src/main/java/org/mars_sim/rest/dto/ReferencableDTO.java b/rest-server/src/main/java/org/mars_sim/rest/dto/ReferencableDTO.java
@@ -1,5 +1,6 @@
 package org.mars_sim.rest.dto;
 
+
 import lombok.Getter;
 import lombok.Setter;
 
@@ -8,7 +9,10 @@
  */
 @Getter @Setter
 public class ReferencableDTO {
+
     private String name; 
+
     private String type; 
+
     private int identifier; 
 }
diff --git a/rest-server/src/main/java/org/mars_sim/rest/mapper/PersonMapper.java b/rest-server/src/main/java/org/mars_sim/rest/mapper/PersonMapper.java
@@ -0,0 +1,20 @@
+package org.mars_sim.rest.mapper;
+
+import org.mapstruct.InheritConfiguration;
+import org.mapstruct.Mapper;
+import org.mapstruct.Mapping;
+import org.mars_sim.rest.dto.PersonDTO;
+import org.mars_sim.rest.dto.PersonSummaryDTO;
+import org.mars_sim.rest.model.Person;
+
+
+@Mapper
+public interface PersonMapper {
+    @Mapping(target = "conditionPerformance", source="condition.performance")
+    @Mapping(target = "conditionEnergy", source="condition.energy")
+    @Mapping(target = "conditionHealth", source="condition.health")
+    PersonSummaryDTO toSummary(Person source);
+
+    @InheritConfiguration(name = "toSummary")
+    PersonDTO toFull(Person source);   
+}
diff --git a/rest-server/src/main/java/org/mars_sim/rest/mapper/SettlementMapper.java b/rest-server/src/main/java/org/mars_sim/rest/mapper/SettlementMapper.java
@@ -0,0 +1,15 @@
+package org.mars_sim.rest.mapper;
+
+import org.mapstruct.InheritConfiguration;
+import org.mapstruct.Mapper;
+import org.mars_sim.rest.dto.SettlementDTO;
+import org.mars_sim.rest.dto.SettlementSummaryDTO;
+import org.mars_sim.rest.model.Settlement;
+
+@Mapper
+public interface SettlementMapper {
+    SettlementSummaryDTO toSummary(Settlement source);
+
+    @InheritConfiguration(name = "toSummary")
+    SettlementDTO toFull(Settlement source);   
+}
diff --git a/rest-server/src/main/java/org/mars_sim/rest/model/Person.java b/rest-server/src/main/java/org/mars_sim/rest/model/Person.java
@@ -1,20 +1,68 @@
 package org.mars_sim.rest.model;
 
-import lombok.AllArgsConstructor;
-import lombok.Getter;
 
-@AllArgsConstructor
+
 public class Person implements Referencable {
-    @Getter private String name; 
-    @Getter private String type; 
-    @Getter private int identifier; 
-    @Getter private String job; 
-    @Getter private String role; 
-    @Getter private String gender; 
-    @Getter private String building; 
-    @Getter private PhysicalCondition condition; 
-    @Getter private String task;
-    @Getter private ReportingAuthority authority;
-    @Getter private Settlement settlement; 
+    private String name; 
+    private String type; 
+    private int identifier; 
+    private String job; 
+    private String role; 
+    private String gender; 
+    private String building; 
+    private PhysicalCondition condition; 
+    private String task;
+    private ReportingAuthority authority;
+    private Settlement settlement; 
+
+    Person(String name, String type, int identifier, String job, String role, String gender, String building,
+            PhysicalCondition condition, String task, ReportingAuthority authority, Settlement settlement) {
+        this.name = name;
+        this.type = type;
+        this.identifier = identifier;
+        this.job = job;
+        this.role = role;
+        this.gender = gender;
+        this.building = building;
+        this.condition = condition;
+        this.task = task;
+        this.authority = authority;
+        this.settlement = settlement;
+    }
+    
+    public String getName() {
+        return name;
+    }
+    public String getType() {
+        return type;
+    }
+    public int getIdentifier() {
+        return identifier;
+    }
+    public String getJob() {
+        return job;
+    }
+    public String getRole() {
+        return role;
+    }
+    public String getGender() {
+        return gender;
+    }
+    public String getBuilding() {
+        return building;
+    }
+    public PhysicalCondition getCondition() {
+        return condition;
+    }
+    public String getTask() {
+        return task;
+    }
+    public ReportingAuthority getAuthority() {
+        return authority;
+    }
+    public Settlement getSettlement() {
+        return settlement;
+    }
+
 
 }
diff --git a/rest-server/src/main/java/org/mars_sim/rest/model/PhysicalCondition.java b/rest-server/src/main/java/org/mars_sim/rest/model/PhysicalCondition.java
@@ -1,11 +1,26 @@
 package org.mars_sim.rest.model;
 
-import lombok.AllArgsConstructor;
-import lombok.Getter;
 
-@Getter @AllArgsConstructor
 public class PhysicalCondition {
     private float performance;
     private String health;
     private float energy;
+    
+    PhysicalCondition(float performance, String health, float energy) {
+        this.performance = performance;
+        this.health = health;
+        this.energy = energy;
+    }
+
+    public float getPerformance() {
+        return performance;
+    }
+    public String getHealth() {
+        return health;
+    }
+    public float getEnergy() {
+        return energy;
+    }
+
+    
 }
diff --git a/rest-server/src/main/java/org/mars_sim/rest/model/ReportingAuthority.java b/rest-server/src/main/java/org/mars_sim/rest/model/ReportingAuthority.java
@@ -1,16 +1,27 @@
 package org.mars_sim.rest.model;
 
-import java.util.ArrayList;
 import java.util.List;
 
-import lombok.AllArgsConstructor;
-import lombok.Getter;
 
-@AllArgsConstructor
-@Getter
 public class ReportingAuthority {
     private String name; 
     private String objective; 
-    private List<String> agenda = new ArrayList<>();
+    private List<String> agenda;
+    
+    ReportingAuthority(String name, String objective, List<String> agenda) {
+        this.name = name;
+        this.objective = objective;
+        this.agenda = agenda;
+    }
+    public String getName() {
+        return name;
+    }
+    public String getObjective() {
+        return objective;
+    }
+    public List<String> getAgenda() {
+        return agenda;
+    }
+    
     
 }
diff --git a/rest-server/src/main/java/org/mars_sim/rest/model/Settlement.java b/rest-server/src/main/java/org/mars_sim/rest/model/Settlement.java
diff --git a/rest-server/src/main/java/org/mars_sim/rest/model/Simulation.java b/rest-server/src/main/java/org/mars_sim/rest/model/Simulation.java

Original file line number	Diff line number	Diff line change
`@@ -5,6 +5,9 @@`
`5`	`5`
`6`	`6`	`@Getter @Setter`
`7`	`7`	`public class PersonDTO extends PersonSummaryDTO {`
	`8`	`+`
`8`	`9`	`private ReferencableDTO settlement;`
	`10`	`+`
	`11`	`+`
`9`	`12`	`private ReportingAuthorityDTO authority;`
`10`	`13`	`}`