🌻 👨🏿‍🏭 💚 ModelMapper: ذهابا وإيابا 🎢 🆗 🛢️

لأسباب معروفة ، لا يمكن للجهة الخلفية إرجاع البيانات من المستودع كما هي. الأكثر شهرة - لا تؤخذ التبعيات الأساسية من القاعدة في الشكل الذي يمكن للجبهة فهمها. هنا يمكنك إضافة صعوبات في تحليل التعداد (إذا كانت حقول التعداد تحتوي على معلمات إضافية) ، والعديد من الصعوبات الأخرى الناشئة عن الصب التلقائي للكتابة (أو عدم القدرة على إلقاءها تلقائيًا). هذا يعني الحاجة إلى استخدام كائن نقل البيانات - DTO ، وهو أمر مفهوم لكل من الخلف والأمام.
يمكن إجراء تحويل كيان إلى DTO بعدة طرق مختلفة. يمكنك استخدام المكتبة ، يمكنك (إذا كان المشروع صغيرًا) إنشاء شيء مثل هذا:

@Component public class ItemMapperImpl implements ItemMapper { private final OrderRepository orderRepository; @Autowired public ItemMapperImpl(OrderRepository orderRepository) { this.orderRepository = orderRepository; } @Override public Item toEntity(ItemDto dto) { return new Item( dto.getId(), obtainOrder(dto.getOrderId()), dto.getArticle(), dto.getName(), dto.getDisplayName(), dto.getWeight(), dto.getCost(), dto.getEstimatedCost(), dto.getQuantity(), dto.getBarcode(), dto.getType() ); } @Override public ItemDto toDto(Item item) { return new ItemDto( item.getId(), obtainOrderId(item), item.getArticle(), item.getName(), item.getDisplayName(), item.getWeight(), item.getCost(), item.getEstimatedCost(), item.getQuantity(), item.getBarcode(), item.getType() ); } private Long obtainOrderId(Item item) { return Objects.nonNull(item.getOrder()) ? item.getOrder().getId() : null; } private Order obtainOrder(Long orderId) { return Objects.nonNull(orderId) ? orderRepository.findById(orderId).orElse(null) : null; } }

هذه المخططات المكتوبة ذاتيا لها عيوب واضحة:

لا مقياس.
عند إضافة / إزالة حتى الحقل الأكثر أهمية ، سيكون عليك تحرير المخطط.

لذلك ، الحل الصحيح هو استخدام مكتبة معين. أنا أعرف modelmapper و mapstruct. منذ أن عملت مع عارض النماذج ، سأتحدث عن ذلك ، لكن إذا كنت ، أيها القارئ الخاص بك ، على دراية جيدة بـ mapstruct ويمكن أن تخبرنا بكل التفاصيل الدقيقة لتطبيقه ، فيرجى كتابة مقال حوله ، وسأكون أول من يكتبه لي (هذه المكتبة هي أيضًا مثيرة للاهتمام ، ولكن ليس هناك وقت للدخول إليها حتى الآن).

لذلك modelmapper.

أريد أن أقول على الفور أنه إذا كان هناك شيء غير واضح لك ، فيمكنك تنزيل المشروع النهائي من خلال اختبار عملي ، رابط في نهاية المقالة.

الخطوة الأولى هي ، بالطبع ، إضافة تبعية. أستخدم ميزة gradle ، لكن من السهل عليك إضافة تبعية إلى مشروع maven الخاص بك.

 compile group: 'org.modelmapper', name: 'modelmapper', version: '2.3.2'

هذا يكفي لتشغيل المصمم. بعد ذلك ، نحن بحاجة إلى إنشاء صندوق.

 @Bean public ModelMapper modelMapper() { ModelMapper mapper = new ModelMapper(); mapper.getConfiguration() .setMatchingStrategy(MatchingStrategies.STRICT) .setFieldMatchingEnabled(true) .setSkipNullEnabled(true) .setFieldAccessLevel(PRIVATE); return mapper; }

عادةً ما يكفي مجرد إرجاع ModelMapper جديد ، ولكن لن يكون من الضروري تكوين المخطط لتلبية احتياجاتنا. قمت بتعيين استراتيجية مطابقة صارمة ، وتمكين تعيين الحقل ، وتخطي الحقول الخالية ، وتعيين مستوى خاص من الوصول إلى الحقول.

بعد ذلك ، قم بإنشاء بنية الكيان التالية. سيكون لدينا يونيكورن ، والذي سيكون له عدد معين من مرؤوسيه ، وكل واحد منهم سيكون لديه عدد معين من الكعك.

الكيانات

الأصل مجردة:

 @MappedSuperclass @Setter @EqualsAndHashCode @NoArgsConstructor @AllArgsConstructor public abstract class AbstractEntity implements Serializable { Long id; LocalDateTime created; LocalDateTime updated; @Id @GeneratedValue public Long getId() { return id; } @Column(name = "created", updatable = false) public LocalDateTime getCreated() { return created; } @Column(name = "updated", insertable = false) public LocalDateTime getUpdated() { return updated; } @PrePersist public void toCreate() { setCreated(LocalDateTime.now()); } @PreUpdate public void toUpdate() { setUpdated(LocalDateTime.now()); } }

يونيكورن:

 @Entity @Table(name = "unicorns") @EqualsAndHashCode(callSuper = false) @Setter @AllArgsConstructor @NoArgsConstructor public class Unicorn extends AbstractEntity { private String name; private List<Droid> droids; private Color color; public Unicorn(String name, Color color) { this.name = name; this.color = color; } @Column(name = "name") public String getName() { return name; } @OneToMany(fetch = FetchType.EAGER, cascade = CascadeType.ALL, mappedBy = "unicorn") public List<Droid> getDroids() { return droids; } @Column(name = "color") public Color getColor() { return color; } }

الروبوت:

 @Setter @EqualsAndHashCode(callSuper = false) @Entity @Table(name = "droids") @AllArgsConstructor @NoArgsConstructor public class Droid extends AbstractEntity { private String name; private Unicorn unicorn; private List<Cupcake> cupcakes; private Boolean alive; public Droid(String name, Unicorn unicorn, Boolean alive) { this.name = name; this.unicorn = unicorn; this.alive = alive; } public Droid(String name, Boolean alive) { this.name = name; this.alive = alive; } @Column(name = "name") public String getName() { return name; } @ManyToOne(fetch = FetchType.EAGER) @JoinColumn(name = "unicorn_id") public Unicorn getUnicorn() { return unicorn; } @OneToMany(fetch = FetchType.EAGER, cascade = CascadeType.ALL, mappedBy = "droid") public List<Cupcake> getCupcakes() { return cupcakes; } @Column(name = "alive") public Boolean getAlive() { return alive; } }

كب كيك:

 @Entity @Table(name = "cupcakes") @Setter @EqualsAndHashCode(callSuper = false) @AllArgsConstructor @NoArgsConstructor public class Cupcake extends AbstractEntity { private Filling filling; private Droid droid; @Column(name = "filling") public Filling getFilling() { return filling; } @ManyToOne(fetch = FetchType.EAGER) @JoinColumn(name = "droid_id") public Droid getDroid() { return droid; } public Cupcake(Filling filling) { this.filling = filling; } }

سنقوم بتحويل هذه الكيانات إلى DTO. هناك طريقتان على الأقل لتحويل التبعيات من كيان إلى DTO. واحد يعني حفظ المعرف فقط بدلاً من الكيان ، ولكن بعد ذلك كل كيان من التبعية ، إذا لزم الأمر ، سنقوم بسحب المعرف بالإضافة إلى ذلك. النهج الثاني ينطوي على الحفاظ على DTO التابعة. لذلك ، في الطريقة الأولى ، سنقوم بتحويل List droids إلى List droids (نقوم فقط بتخزين المعرفات في القائمة الجديدة) ، وفي الطريقة الثانية ، سوف نقوم بحفظها في List droids.

DTO

الأصل مجردة:

 @Data public abstract class AbstractDto implements Serializable { private Long id; @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd HH:mm:ss.SSS") LocalDateTime created; @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd HH:mm:ss.SSS") LocalDateTime updated; }

UnicornDto:

 @EqualsAndHashCode(callSuper = true) @Data @NoArgsConstructor @AllArgsConstructor public class UnicornDto extends AbstractDto { private String name; private List<DroidDto> droids; private String color; }

DroidDto:

 @EqualsAndHashCode(callSuper = true) @Data @NoArgsConstructor @AllArgsConstructor public class DroidDto extends AbstractDto { private String name; private List<CupcakeDto> cupcakes; private UnicornDto unicorn; private Boolean alive; }

CupcakeDto:

 @EqualsAndHashCode(callSuper = true) @Data @NoArgsConstructor @AllArgsConstructor public class CupcakeDto extends AbstractDto { private String filling; private DroidDto droid; }

لضبط المصمم حسب احتياجاتنا ، سنحتاج إلى إنشاء فئة مجمّع خاصة بنا وإعادة تحديد منطق مجموعات التعيين. للقيام بذلك ، نقوم بإنشاء فئة مكون UnicornMapper ، ونقوم بالتعيين التلقائي لمخططنا هناك وإعادة تحديد الأساليب التي نحتاجها.

يبدو أبسط إصدار من فئة المجمع مثل هذا:

 @Component public class UnicornMapper { @Autowired private ModelMapper mapper; @Override public Unicorn toEntity(UnicornDto dto) { return Objects.isNull(dto) ? null : mapper.map(dto, Unicorn.class); } @Override public UnicornDto toDto(Unicorn entity) { return Objects.isNull(entity) ? null : mapper.map(entity, UnicornDto.class); } }

الآن ، يكفي أن نضيف مصمم الخرائط الخاص بنا إلى خدمة ما وسحبها باستخدام أساليب toDto و toEntity. سيقوم مخطط معين بتحويل الكيانات الموجودة في الكائن إلى DTO ، DTO - إلى كيانات.

 @Service public class UnicornServiceImpl implements UnicornService { private final UnicornRepository repository; private final UnicornMapper mapper; @Autowired public UnicornServiceImpl(UnicornRepository repository, UnicornMapper mapper) { this.repository = repository; this.mapper = mapper; } @Override public UnicornDto save(UnicornDto dto) { return mapper.toDto(repository.save(mapper.toEntity(dto))); } @Override public UnicornDto get(Long id) { return mapper.toDto(repository.getOne(id)); } }

ولكن إذا حاولنا تحويل شيء ما بهذه الطريقة ، ثم اتصلنا ، على سبيل المثال ، بـ "سلسلة" ، فسنحصل على StackOverflowException ، وإليكم السبب: يحتوي UnicornDto على قائمة DroidDto ، التي تحتوي على UnicornDto ، والتي تحتوي على DroidDto ، وهكذا حتى تلك اللحظة حتى نفاد ذاكرة المكدس. لذلك ، بالنسبة إلى التبعيات المعكوسة ، عادةً ما أستخدم UnicornDto unicorn ، لكن Long unicornId. وبهذه الطريقة ، نبقى على اتصال مع يونيكورن ، لكننا نقطع الاعتماد التبعي الدوري. دعونا إصلاح DTOs لدينا بحيث بدلاً من DTOs العكسي ، فإنها تخزن معرفات تبعياتهم.

 @EqualsAndHashCode(callSuper = true) @Data @NoArgsConstructor @AllArgsConstructor public class DroidDto extends AbstractDto { ... //private UnicornDto unicorn; private Long unicornId; ... }

و هكذا.

ولكن الآن ، إذا اتصلنا بـ DroidMapper ، فسنحصل على unicornId == فارغة. هذا لأنه لا يمكن لـ ModelMapper تحديد نوع Long بالضبط. وفقط لا يزعجه. وسيتعين علينا ضبط المصممين الضروريين لتعليمهم كيفية تعيين الكيانات في المعرفات.

نذكر أنه مع كل صندوق بعد التهيئة ، يمكنك العمل يدويًا.

  @PostConstruct public void setupMapper() { mapper.createTypeMap(Droid.class, DroidDto.class) .addMappings(m -> m.skip(DroidDto::setUnicornId)).setPostConverter(toDtoConverter()); mapper.createTypeMap(DroidDto.class, Droid.class) .addMappings(m -> m.skip(Droid::setUnicorn)).setPostConverter(toEntityConverter()); }

فيPostConstruct سنضع القواعد التي نشير فيها إلى الحقول التي لا يجب على المخطط تعيينها ، لأننا سنحدد المنطق الخاص بنا. في حالتنا ، هذا هو تعريف unicornId في DTO ، وتعريف Unicorn في جوهره (نظرًا لأن المصمم لا يعرف أيضًا ما يجب فعله مع Long unicornId).

TypeMap - هذه هي القاعدة التي نحدد فيها جميع الفروق الدقيقة في التعيين ، وأيضًا ، قم بتعيين المحول. لقد أوضحنا أنه للتحويل من Droid إلى DroidDto ، نتخطى setUnicornId ، وفي التحويل العكسي ، نمر setUnicorn. سنقوم جميعًا بالتحويل في محول toDtoConverter () لـ UnicornDto وفي toEntityConverter () لـ Unicorn. يجب أن نصف هذه المحولات في المكون الخاص بنا.

أبسط ما بعد المحول يشبه هذا:

  Converter<UnicornDto, Unicorn> toEntityConverter() { return MappingContext::getDestination; }

نحن بحاجة إلى توسيع وظائفها:

  public Converter<UnicornDto, Unicorn> toEntityConverter() { return context -> { UnicornDto source = context.getSource(); Unicorn destination = context.getDestination(); mapSpecificFields(source, destination); return context.getDestination(); }; }

نفعل نفس الشيء مع المحول العكسي:

  public Converter<Unicorn, UnicornDto> toDtoConverter() { return context -> { Unicorn source = context.getSource(); UnicornDto destination = context.getDestination(); mapSpecificFields(source, destination); return context.getDestination(); }; }

في الواقع ، نقوم ببساطة بإدخال طريقة إضافية في كل محول لاحق ، نكتب فيه منطقنا الخاص للحقول المفقودة.

  public void mapSpecificFields(Droid source, DroidDto destination) { destination.setUnicornId(Objects.isNull(source) || Objects.isNull(source.getId()) ? null : source.getUnicorn().getId()); } void mapSpecificFields(DroidDto source, Droid destination) { destination.setUnicorn(unicornRepository.findById(source.getUnicornId()).orElse(null)); }

عند التعيين في DTO ، نقوم بتعيين معرف الكيان. عند التعيين في DTO ، نحصل على الكيان من المستودع بمعرف.

وهذا كل شيء.

لقد أظهرت الحد الأدنى الضروري لبدء العمل مع modelmapper ولم تقم بإعادة تشكيل الرمز بشكل خاص. إذا كنت ، أيها القارئ ، لديك ما تضيفه إلى مقالتي ، فسأكون سعيدًا لسماع النقد البناء.

يمكن الاطلاع على المشروع هنا:
مشروع على جيثب.

من المحتمل أن يكون عشاق الكود النظيف قد رأوا بالفعل الفرصة لدفع العديد من مكونات الكود إلى التجريد. إذا كنت واحدا منهم ، أقترح تحت القط.

رفع مستوى التجريد

بادئ ذي بدء ، نقوم بتعريف واجهة للطرق الأساسية لفئة الالتفاف.

 public interface Mapper<E extends AbstractEntity, D extends AbstractDto> { E toEntity(D dto); D toDto(E entity); }

نرث منه طبقة مجردة.

 public abstract class AbstractMapper<E extends AbstractEntity, D extends AbstractDto> implements Mapper<E, D> { @Autowired ModelMapper mapper; private Class<E> entityClass; private Class<D> dtoClass; AbstractMapper(Class<E> entityClass, Class<D> dtoClass) { this.entityClass = entityClass; this.dtoClass = dtoClass; } @Override public E toEntity(D dto) { return Objects.isNull(dto) ? null : mapper.map(dto, entityClass); } @Override public D toDto(E entity) { return Objects.isNull(entity) ? null : mapper.map(entity, dtoClass); } Converter<E, D> toDtoConverter() { return context -> { E source = context.getSource(); D destination = context.getDestination(); mapSpecificFields(source, destination); return context.getDestination(); }; } Converter<D, E> toEntityConverter() { return context -> { D source = context.getSource(); E destination = context.getDestination(); mapSpecificFields(source, destination); return context.getDestination(); }; } void mapSpecificFields(E source, D destination) { } void mapSpecificFields(D source, E destination) { } }

يمكن إرسال المحولات اللاحقة وطرق ملء الحقول المحددة بأمان إلى هناك. أيضًا ، قم بإنشاء كائنين من النوع Class ومنشئ لتهيئةهما:

  private Class<E> entityClass; private Class<D> dtoClass; AbstractMapper(Class<E> entityClass, Class<D> dtoClass) { this.entityClass = entityClass; this.dtoClass = dtoClass; }

الآن يتم تقليل مقدار التعليمات البرمجية في DroidMapper إلى ما يلي:

 @Component public class DroidMapper extends AbstractMapper<Droid, DroidDto> { private final ModelMapper mapper; private final UnicornRepository unicornRepository; @Autowired public DroidMapper(ModelMapper mapper, UnicornRepository unicornRepository) { super(Droid.class, DroidDto.class); this.mapper = mapper; this.unicornRepository = unicornRepository; } @PostConstruct public void setupMapper() { mapper.createTypeMap(Droid.class, DroidDto.class) .addMappings(m -> m.skip(DroidDto::setUnicornId)).setPostConverter(toDtoConverter()); mapper.createTypeMap(DroidDto.class, Droid.class) .addMappings(m -> m.skip(Droid::setUnicorn)).setPostConverter(toEntityConverter()); } @Override public void mapSpecificFields(Droid source, DroidDto destination) { destination.setUnicornId(getId(source)); } private Long getId(Droid source) { return Objects.isNull(source) || Objects.isNull(source.getId()) ? null : source.getUnicorn().getId(); } @Override void mapSpecificFields(DroidDto source, Droid destination) { destination.setUnicorn(unicornRepository.findById(source.getUnicornId()).orElse(null)); } }

مخطط معين بدون حقول محددة يبدو عمومًا بسيطًا:

 @Component public class UnicornMapper extends AbstractMapper<Unicorn, UnicornDto> { @Autowired public UnicornMapper() { super(Unicorn.class, UnicornDto.class); } }

ModelMapper: ذهابا وإيابا

More articles: