Jdbi3官方教程（六） 映射器Mapper

Jdbi3官方教程（一） 简介
Jdbi3官方教程（二） 入门
Jdbi3官方教程（三） Jdbi和Handle
Jdbi3官方教程（四） 参数绑定
Jdbi3官方教程（五） 查询Query
Jdbi3官方教程（六） 映射器Mapper

3.5 映射器

Jdbi利用映射器将结果数据转换为Java对象。有两种类型的映射器：

3.5.1 行映射器

RowMapper是一个函数接口，它将JDBC ResultSet的当前行 映射到被映射的类型。对于结果集中的每一行，将调用一次行映射器。

由于RowMapper是一个函数接口，因此可以使用lambda表达式将它们内联到查询中：

List<User> users = handle.createQuery("SELECT id, name FROM user ORDER BY id ASC")
        .map((rs, ctx) -> new User(rs.getInt("id"), rs.getString("name")))
        .list();
  • mapTo加类型，map加映射函数

在上面的例子中使用了三种不同的类型。Handle.createQuery()返回的Query，实现了ResultBearing接口。该ResultBearing.map()方法采输入一个 RowMapper<T>并返回一个 ResultIterable<T>。最后，ResultBearing.list()将结果集中的每一行收集到一个List<T>。

行映射器可以定义为类，允许重用：

class UserMapper implements RowMapper<User> {
    @Override
    public User map(ResultSet rs, StatementContext ctx) throws SQLException {
        return new User(rs.getInt("id"), rs.getString("name"));
    }
}

List<User> users = handle.createQuery("SELECT id, name FROM user ORDER BY id ASC")
    .map(new UserMapper())
    .list();

RowMapper相当于上面的lambda映射器，但更明确。

RowMappers注册表

可以为特定类型注册行映射器。这简化了使用，只需要指定要映射到的类型。Jdbi会自动从注册表中查找映射器并使用它。

jdbi.registerRowMapper(User.class,
    (rs, ctx) -> new User(rs.getInt("id"), rs.getString("name"));

try (Handle handle = jdbi.open()) {
  List<User> users = handle.createQuery("SELECT id, name FROM user ORDER BY id ASC")
        .mapTo(User.class)
        .list();
}

它实现了一个映射器RowMapper具有显式映射类型（如 UserMapper前一节中的类）可以被注册，而无需指定映射类型：

handle.registerRowMapper(new UserMapper());

使用此方法时，Jdbi会检查映射器的泛型类签名以自动发现映射类型。

  • jdbi和handle都能注册
  • 可以注册Mapper，也可以动态注册映射函数

对于任何给定类型，可以注册多个映射器。发生这种情况时，给定类型的最后注册的映射器优先。这允许进行优化，例如为某些类型注册“默认”映射器，同时允许在适当时使用不同的映射器覆盖该默认映射器。

RowMapperFactory

待补充...

3.5.2 列映射器

ColumnMapper是一个函数式接口，它将JDBC ResultSet的当前行中的列 映射到映射类型。

由于ColumnMapper是一个函数式接口，因此可以使用lambda表达式将它们内联到查询中：

List<Money> amounts = handle
    .select("select amount from transactions where account_id = ?", accountId)
    .map((rs, col, ctx) -> Money.parse(rs.getString(col))) 
    .list();

每当使用列映射器映射行时，只映射每行的第一列。

列映射器可以定义为类，允许重用：

public class MoneyMapper implements ColumnMapper<Money> {
  public T map(ResultSet r, int columnNumber, StatementContext ctx) throws SQLException {
    return Money.parse(r.getString(columnNumber));
  }
}
List<Money> amounts = handle
    .select("select amount from transactions where account_id = ?", accountId)
    .map(new MoneyMapper())
    .list();

这ColumnMapper相当于上面的lambda映射器，但更明确。

ColumnMappers注册表

可以为特定类型注册列映射器。这简化了使用，只需要指定要映射到的类型。Jdbi会自动从注册表中查找映射器并使用它。

jdbi.registerColumnMapper(Money.class,
    (rs, col, ctx) -> Money.parse(rs.getString(col)));

List<Money> amounts = jdbi.withHandle(handle ->
    handle.select("select amount from transactions where account_id = ?", accountId)
          .mapTo(Money.class)
          .list());

它实现了一个映射器ColumnMapper具有显式映射类型（如MoneyMapper前一节中的类）可以被注册，而无需指定映射类型：

handle.registerColumnMapper(new MoneyMapper());

使用此方法时，Jdbi会检查映射器的泛型类签名以自动发现映射类型。

对于任何给定类型，可以注册多个映射器。发生这种情况时，给定类型的最后注册的映射器优先。这允许进行优化，例如为某些类型注册“默认”映射器，同时允许在适当时使用不同的映射器覆盖该默认映射器。

列映射器注册了以下类型：

  • 原语：boolean，byte，short，int，long，char，float，和 double
  • java.lang中：Boolean，Byte，Short，Integer，Long，Character， Float，Double，String，和Enum（存储为枚举值的名字）
  • java.math中： BigDecimal
  • byte[] 数组（例如BLOB或VARBINARY列）
  • java.net： ，InetAddress，URL和URI
  • java.sql中： Timestamp
  • java.time： ，Instant，LocalDate，LocalDateTime，LocalTime，OffsetDateTime，ZonedDateTime和ZoneId
  • java.util中： UUID
  • java.util.Collection和Java数组（用于数组列）。根据数组元素的类型，可能还需要一些额外的设置 - 请参阅 SQL数组。
ColumnMapperFactory

待补充...

3.5.3 反射映射器

Jdbi提供了一些开箱即用的基于反射的映射器。

反射映射器将列名视为bean属性名称（BeanMapper），构造函数参数名称（ConstructorMapper）或字段名称（FieldMapper）。

反射映射器可识别snake_case，并会自动将这些列与camelCase字段/参数/属性名称匹配。

ConstructorMapper

Jdbi提供了一个简单的构造函数映射器，它使用反射按名称将列分配给构造函数参数。

@ConstructorProperties({"id", "name"})
public User(int id, String name) {
  this.id = id;
  this.name = name;
}

该@ConstructorProperties注解告诉Jdbi每个构造函数参数的属性名称，因此它可以找出哪些列对应于每一个构造函数的参数。

启用-parametersJava编译器标志将不再需要 @ConstructorProperties注释 - 请参阅使用参数名称进行编译。从而：

public User(int id, String name) {
    this.id = id;
    this.name = name;
}

使用以下factory() 方法为映射的类注册构造函数映射器：

handle.registerRowMapper(ConstructorMapper.factory(User.class));
Set<User> userSet = handle.createQuery("SELECT * FROM user ORDER BY id ASC")
    .mapTo(User.class)
    .collect(Collectors.toSet());

assertThat(userSet).hasSize(4);

构造函数参数名称“id”，“name”与数据库列名称匹配，因此根本不需要自定义映射器代码。

可以为每个映射的构造函数参数配置构造函数映射器的列名前缀。这有助于消除映射连接的歧义，例如，当两个映射的类具有相同的属性名称（如id或name）时：

handle.registerRowMapper(ConstructorMapper.factory(Contact.class, "c"));
handle.registerRowMapper(ConstructorMapper.factory(Phone.class, "p"));
handle.registerRowMapper(JoinRowMapper.forTypes(Contact.class, Phone.class);
List<JoinRow> contactPhones = handle.select("select " +
        "c.id cid, c.name cname, " +
        "p.id pid, p.name pname, p.number pnumber " +
        "from contacts c left join phones p on c.id = p.contact_id")
    .mapTo(JoinRow.class)
    .list();

通常，映射的类将具有单个构造函数。如果它有多个构造函数，Jdbi将根据这些规则选择一个：

  • 首先，使用带注释的构造函数@JdbiConstructor（如果有）。
  • 接下来，使用带注释的构造函数@ConstructorProperties（如果有）。
  • 否则，抛出Jdbi不知道要使用哪个构造函数的异常。

对于与属性名称不匹配的旧列名称，请使用 @ColumnName批注提供精确的列名称。

public User(@ColumnName("user_id") int id, String name) {
  this.id = id;
  this.name = name;
}

可以使用@Nested注释映射嵌套的构造函数注入类型：

public class User {
  public User(int id,
              String name,
              @Nested Address address) {
    ...
  }
}

public class Address {
  public Address(String street,
                 String city,
                 String state,
                 String zip) {
    ...
  }
}
handle.registerRowMapper(ConstructorMapper.factory(User.class));

List<User> users = handle
    .select("select id, name, street, city, state, zip from users")
    .mapTo(User.class)
    .list();

该@Nested注释有一个可选的value()属性，该属性可以被用于一列名的前缀应用于每个嵌套构造参数：

public User(int id,
            String name,
            @Nested("addr") Address address) {
  ...
}
handle.registerRowMapper(ConstructorMapper.factory(User.class));

List<User> users = handle
    .select("select id, name, addr_street, addr_city, addr_state, addr_zip from users")
    .mapTo(User.class)
    .list();
BeanMapper

我们还为映射bean提供基本支持：

public class UserBean {
    private int id;
    private String name;

    public int getId() {
        return id;
    }
    public void setId(int id) {
        this.id = id;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
}

使用以下factory()方法为映射的类注册bean映射器：

handle.registerRowMapper(BeanMapper.factory(UserBean.class));

List<UserBean> users = handle
        .createQuery("select id, name from user")
        .mapTo(UserBean.class)
        .list();

或者，调用mapToBean()而不是注册bean映射器：

List<UserBean> users = handle
        .createQuery("select id, name from user")
        .mapToBean(UserBean.class)
        .list();

可以为每个映射属性配置Bean映射器的列名前缀。这有助于消除映射连接的歧义，例如，当两个映射的类具有相同的属性名称（如id或name）时：

handle.registerRowMapper(BeanMapper.factory(ContactBean.class, "c"));
handle.registerRowMapper(BeanMapper.factory(PhoneBean.class, "p"));
handle.registerRowMapper(JoinRowMapper.forTypes(ContactBean.class, PhoneBean.class));
List<JoinRow> contactPhones = handle.select("select "
        + "c.id cid, c.name cname, "
        + "p.id pid, p.name pname, p.number pnumber "
        + "from contacts c left join phones p on c.id = p.contact_id")
        .mapTo(JoinRow.class)
        .list();

对于与属性名称不匹配的旧列名称，请使用 @ColumnName批注提供精确的列名称。

public class User {
  private int id;

  @ColumnName("user_id")
  public int getId() { return id; }

  public void setId(int id) { this.id = id; }
}

所述@ColumnName注释可以放在任一getter或setter方法。

可以使用@Nested注释映射嵌套的Java Bean类型：

public class User {
  private int id;
  private String name;
  private Address address;

  ... (getters and setters)

  @Nested 
  public Address getAddress() { ... }

  public void setAddress(Address address) { ... }
}

public class Address {
  private String street;
  private String city;
  private String state;
  private String zip;

  ... (getters and setters)
}

handle.registerRowMapper(BeanMapper.factory(User.class));

List<User> users = handle
    .select("select id, name, street, city, state, zip from users")
    .mapTo(User.class)
    .list();

该@Nested注释有一个可选的value()属性，该属性可以被用于一列名的前缀应用于每个嵌套bean属性：

@Nested("addr")
public Address getAddress() { ... }
handle.registerRowMapper(BeanMapper.factory(User.class));

List<User> users = handle
    .select("select id, name, addr_street, addr_city, addr_state, addr_zip from users")
    .mapTo(User.class)
    .list();
FieldMapper

FieldMapper使用反射将数据库列直接映射到对象字段（包括私有字段）。

public class User {
  public int id;

  public String name;
}

使用以下factory()方法为映射的类注册一个字段映射器：

handle.registerRowMapper(FieldMapper.factory(User.class));

List<UserBean> users = handle
        .createQuery("select id, name from user")
        .mapTo(User.class)
        .list();

可以为每个映射字段配置字段映射器的列名前缀。这有助于消除映射连接的歧义，例如，当两个映射的类具有相同的属性名称（如id或name）时：

handle.registerRowMapper(FieldMapper.factory(Contact.class, "c"));
handle.registerRowMapper(FieldMapper.factory(Phone.class, "p"));
handle.registerRowMapper(JoinRowMapper.forTypes(Contact.class, Phone.class);
List<JoinRow> contactPhones = handle.select("select " +
        "c.id cid, c.name cname, " +
        "p.id pid, p.name pname, p.number pnumber " +
        "from contacts c left join phones p on c.id = p.contact_id")
    .mapTo(JoinRow.class)
    .list();

对于与字段名称不匹配的旧列名称，请使用 @ColumnName批注提供精确的列名称：

public class User {
  @ColumnName("user_id")
  public int id;

  public String name;
}

可以使用@Nested注释映射嵌套的字段映射类型：

public class User {
  public int id;
  public String name;

  @Nested
  public Address address;
}

public class Address {
  public String street;
  public String city;
  public String state;
  public String zip;
}
handle.registerRowMapper(FieldMapper.factory(User.class));

List<User> users = handle
    .select("select id, name, street, city, state, zip from users")
    .mapTo(User.class)
    .list();

该@Nested注释有一个可选的value()属性，该属性可以被用于一列名的前缀应用于每个嵌套字段：

public class User {
  public int id;
  public String name;

  @Nested("addr")
  public Address address;
}
handle.registerRowMapper(FieldMapper.factory(User.class));

List<User> users = handle
    .select("select id, name, addr_street, addr_city, addr_state, addr_zip from users")
    .mapTo(User.class)
    .list();
Map.Entry映射

Jdbi注册了一个RowMapper<Map.Entry<K,V>>。由于结果集中的每一行都是Map.Entry<K,V>，因此整个结果集可以很容易地收集到Map<K,V>（或Guava Multimap<K,V>）中。

通过指定通用映射签名，可以将连接行收集到映射结果中：

String sql = "select u.id u_id, u.name u_name, p.id p_id, p.phone p_phone "

    + "from user u left join phone p on u.id = p.user_id";
Map<User, Phone> map = h.createQuery(sql)
        .registerRowMapper(ConstructorMapper.factory(User.class, "u"))
        .registerRowMapper(ConstructorMapper.factory(Phone.class, "p"))
        .collectInto(new GenericType<Map<User, Phone>>() {});

在前面的示例中，User映射器使用“u”列名称前缀，Phone映射器使用“p”。由于每个映射器只读取具有预期前缀的id列，因此相应的列是明确的。

通过设置键列名称可以获得唯一索引（例如，通过ID列）：

Map<Integer, User> map = h.createQuery("select * from user")
        .setMapKeyColumn("id")
        .registerRowMapper(ConstructorMapper.factory(User.class))
        .collectInto(new GenericType<Map<Integer, User>>() {});

设置键列值和值列，以将两列查询收集到映射结果中：

Map<String, String> map = h.createQuery("select key, value from config")
        .setMapKeyColumn("key")
        .setMapValueColumn("value")
        .collectInto(new GenericType<Map<String, String>>() {});

所有上述示例都假设一对一键/值关系。如果有一对多关系怎么办？

Google Guava提供了一种Multimap类型，支持为每个键映射多个值。

首先，按照Google Guava部分中的说明安装 GuavaPlugin到Jdbi中。

然后，只需要一个Multimap而不是Map：

String sql = "select u.id u_id, u.name u_name, p.id p_id, p.phone p_phone "
    + "from user u left join phone p on u.id = p.user_id";
Multimap<User, Phone> map = h.createQuery(sql)
        .registerRowMapper(ConstructorMapper.factory(User.class, "u"))
        .registerRowMapper(ConstructorMapper.factory(Phone.class, "p"))
        .collectInto(new GenericType<Multimap<User, Phone>>() {});

该collectInto()方法值得解释，当调用时，幕后发生了几件事：

  • 请查询JdbiCollectors注册表以获取支持给定容器类型的 CollectorFactory。
  • 接下来，要求CollectorFactory从容器类型签名中提取元素类型。在上面的例子中，元素类型 Multimap<User,Phone>是Map.Entry<User,Phone>。
  • 从映射注册表获取该元素类型的映射器。
  • 从中获取容器类型的收集器CollectorFactory。
  • 最后，回来map(elementMapper).collect(collector)。

可以增强Jdbi以支持任意容器类型。有关详细信息，请参阅 [JdbiCollectors]。

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 212,686评论 6赞 492
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 90,668评论 3赞 385
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 158,160评论 0赞 348
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 56,736评论 1赞 284
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 65,847评论 6赞 386
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 50,043评论 1赞 291
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 39,129评论 3赞 410
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 37,872评论 0赞 268
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 44,318评论 1赞 303
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,645评论 2赞 327
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,777评论 1赞 341
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 34,470评论 4赞 333
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 40,126评论 3赞 317
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,861评论 0赞 21
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,095评论 1赞 267
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 46,589评论 2赞 362
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 43,687评论 2赞 351

推荐阅读更多精彩内容

  • Spring Cloud
    Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具（例如配置管理，服务发现，断路器，智...
    卡卡罗2017阅读 134,637评论 18赞 139
  • 2016年5月Swift 2 学习 --- 117个注意事项与要点
    这是16年5月份编辑的一份比较杂乱适合自己观看的学习记录文档，今天18年5月份再次想写文章，发现简书还为我保存起的...
    Jenaral阅读 2,739评论 2赞 9
  • Spring Framework 5 MVC 官方手册译文
    Spring Web MVC Spring Web MVC 是包含在 Spring 框架中的 Web 框架，建立于...
    Hsinwong阅读 22,366评论 1赞 92
  • 为什么自己要把自己活复杂了？
    经常会因为想着一切合乎常理，把一些事情揽在身上来做，因此来标榜自已是一个值得交的朋友。 经常会不好意思推托一些事情...
    枫五阅读 565评论 1赞 2
  • 剃头匠
    为了戒掉张扬的网瘾，今年暑假张扬的妈妈把他送到乡下姥姥家里去了，要将张扬与网络“隔离”。 “妈，我走了啊，褥子我晒...
    猜火车dreamer阅读 629评论 4赞 1