@Mapper 实体-模型映射

原创性声明:本文完全为笔者原创,请尊重笔者劳动力。转载务必注明原文地址。

domain类是我们用于与数据库映射的实体类,通常在将实体数据序列化发送到客户端时,我们不会吧domain类去序列化,而是将domain类转成一个model,将model序列化作为响应给浏览器的数据。例如,有一个章节类(Chapter):


@Entity
@Table(name = "chapters")
public class Chapter  {
    @Id
    @Column(name = "id", unique = true, nullable = false)
    @GeneratedValue(strategy = GenerationType.IDENTITY)
    private Long id;
    
    @Column(name = "name", nullable = false)
    @ColumnComment("章节名")
    private String name;
    
    @Column(name = "book_id", nullable = false)
    private Long bookId;
    
    @Column(name = "parent_id")
    @ColumnComment("父章节的id,标示从属于哪个章节。如果为null,则表示改章节就是book(顶结点)")
    private Long parentId;
    
    @Column(name = "description", nullable = true)
    private String description;
    
    @Column(name = "sort_num")
    private Integer sortNum;

    // 省略 get/set
}

章节通常是嵌套形成树状结构,当我们需要返回一个树形结构的数据到页面时,就需要构建一个model,如下:

public class ChapterModel {
    
    private Long id;
    
    private Long bookId;
    
    private Long parentId;
    
    private String groupName;
    
    private Integer sortNum;
    
    private String description;

    private List<ChapterModel> items; // 树结构的体现
    
    private int level;
    
    private boolean expanded;

    private boolean isArticle;
    
    private boolean ifCanClick;

    private String parentName;
    
    // 省略 get/set
}

那么问题来了,当我们每次需要处理一个Chapter对象时,都需要创建一个model,将chapter里的数据对应塞进model里,抽成方法就是:entityToModel,而@Mapper就是这个作用,它只需要你去创建一个接口或抽象类(ChapterMapper),然后定义这个entityToModel方法(并不需要去实现),因为它会自动创建继承类(ChapterMapperImpl),并实现这个方法(entityToModel)。事实上,实现方法的内部同样是调用简单set/get,但这为我们省了不少时间。下面继续。

首先,在pom文件中引入依赖:

<dependency>
    <groupId>org.mapstruct</groupId>
    <artifactId>mapstruct-jdk8</artifactId>
    <version>1.2.0.Beta2</version>
</dependency>
<dependency>
    <groupId>org.mapstruct</groupId>
    <artifactId>mapstruct-processor</artifactId>
    <version>1.2.0.Beta2</version>
</dependency>

创建接口:

@Mapper(componentModel = "spring", uses = {})
public interface ChapterMapper {
    public ChapterModel entityToModel(Chapter chapter);
}

重新生成class文件,执行命令: mvn clean compile(我用的是maven)

可以看到在项目target目录下,生成了一个generated-sources目录,下面可以找到ChapterMapperImpl

Paste_Image.png

查看里面的代码,发现entityToModel方法已经被实现了:

Paste_Image.png

细心一点,其实我们可以发现,生成的方法并不够“智能”,返回的model中只有五个属性被赋值了(而这五个属性恰好就是Chapter类的六个属性中的五个),因为mapstruct是根据属性的名字来匹配的,entity中的name属性,在model里找不到同名的属性,所以就忽略了。那么,如果我们要设置呢?让name赋值给model中的groupName?另外还有一种更复杂的需求,我们希望根据ChapterparentId属性查找父级目录Chapter,再将父级目录的name赋值给modelparentName属性,又该怎么处理呢?

只需要给方法加一个注解,并相应配置,再添加一个方法(changeToParentName)即可:

    @Autowired
    private ChapterService chapterService;

    @Mappings({
            @Mapping(source = "chapter.name", target = "groupName"),
            @Mapping(source = "chapter.parentId", target = "parentName"),
    })
    public abstract ChapterModel entityToModel(Chapter chapter);

    public String changeToParentName(Long parentId) {
        if (parentId != null) {
            return chapterService.getNameById(parentId);
        }
        return null;
    }

可以看到,因为要添加一个自定义实现方法changeToParentName,所以我们把<b>接口改成了抽象类</b>

稍微揣摩一下@Mappings({})里的配置属性和值,就不难发现改造映射规则的配置方式。

  1. source 属性的 chapter.name 中的 chapter就是方法的参数名,name当然就是属性名了。target属性,就是需要映射的model的属性名;
  1. changeToParentName这个方法名不是固定的,但是参数值和返回的数据类型却是固定的。

接下来,我们再次用命令重新清理一下class文件。

mvn clean compile

可以发现:

Paste_Image.png

这个实现方法已经没什么问题了!很强势,很给力。最后就可以在业务层面愉快的使用这个方法啦:

ChapterModel model = chapterMapper.entityToModel(chapter)

更多关于mapstruct的内容(例如@Mapper(componentModel = "spring", uses = {})的具体用法)可以参见官网

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 211,265评论 6 490
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,078评论 2 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 156,852评论 0 347
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,408评论 1 283
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,445评论 5 384
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 49,772评论 1 290
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 38,921评论 3 406
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,688评论 0 266
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,130评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,467评论 2 325
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,617评论 1 340
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,276评论 4 329
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 39,882评论 3 312
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,740评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,967评论 1 265
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,315评论 2 360
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,486评论 2 348

推荐阅读更多精彩内容