keycloak~AbstractJsonUserAttributeMapper的作用
AbstractJsonUserAttributeMapper它是一个抽象类，用来更新条件更新用户属性(user_attribute)的信息，我们在实现自己的mapper时，需要关注3个方法，下面分别介绍一下：
getCompatibleProviders方法
它用来直指你的mapper是绑定到哪个认证服务下面的，即这个mapper支持的provider，例如你想在微信登录后执行这个mapper，你就把微信的provider.id写到这个方法里返回它即可
create方法
这个比较简单，主要用来返回当前mapper的实例对象
updateBrokeredUser方法
这是属性绑定的核心方法，用来解析第三方返回的json数据与你用户属性和用户实体里的字段的对应关系，你可以理解为字段映射的过程
实例
[*]更新用户的firstName和属性表里的wechat-unionId字段
public class CustomUserAttributeMapper extends AbstractJsonUserAttributeMapper {
public static final String PROVIDER_ID = "custom-user-attribute-mapper";
private static final String[] cp = new String[]{WeiXinIdentityProviderFactory.PROVIDER_ID};
private static final Logger logger = Logger.getLogger(CustomUserAttributeMapper.class);
@Override
public String[] getCompatibleProviders() {
return cp;
}
@Override
public String getId() {
return PROVIDER_ID;
}
@Override
public void updateBrokeredUser(KeycloakSession session, RealmModel realm, UserModel user, IdentityProviderMapperModel mapperModel, BrokeredIdentityContext context) {
user.setFirstName(context.getFirstName());
// 扩展属性
user.setSingleAttribute("wechat-unionId", context.getBrokerUserId());
}
@Override
public CustomUserAttributeMapper create(KeycloakSession session) {
logger.info("CustomUserAttributeMapper.create");
return new CustomUserAttributeMapper();
}
}
[*]注册这个mapper到SPI容器
# resources/META-INFO/services/org.keycloak.broker.provider.IdentityProviderMapper文件
org.keycloak.broker.provider.IdentityProviderMapper
[*]微信扫码之后，我们可以看到用户属性已经加上了
https://img2023.cnblogs.com/blog/118538/202307/118538-20230717130358733-1170095232.png
AbstractJsonUserAttributeMapper的好处
[*]不需要修改第三方登录的核心逻辑
[*]符合OCP原则，对扩展开放
[*]符合SRP原则，一个类只做一件事
不使用AbstractJsonUserAttributeMapper
[*]代码耦合到AbstractOAuth2IdentityProvider类里，重写它的extractIdentityFromProfile方法，再调用AbstractJsonUserAttributeMapper完成持久化
@Override
protected BrokeredIdentityContext extractIdentityFromProfile(EventBuilder event, JsonNode profile) {
String uuionid = getJsonProperty(profile, "unionid");
BrokeredIdentityContext user = new BrokeredIdentityContext(
(uuionid != null && uuionid.length() > 0 ? uuionid : getJsonProperty(profile, "openid")));
user.setUsername(getJsonProperty(profile, "openid"));
user.setBrokerUserId(uuionid);
user.setModelUsername(getJsonProperty(profile, "nickname"));
user.setName(getJsonProperty(profile, "nickname"));
user.setUserAttribute("latestTime", LocalDateTime.now().toString());
user.setIdpConfig(getConfig());
user.setIdp(this);
AbstractJsonUserAttributeMapper.storeUserProfileForMapper(user, profile, getConfig().getAlias());
return user;
}
免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！
页:
[1]