spring boot 操作ldap，新增用户的源码及示例

说在前面的话

本文只讲述如果使用spring-ldap-core 中的LdapTemplate类来操作新增用户，其他操作不在本文的范围内。相信，你查看它的源码类，便能类推出来。

本文会对用户的一些属性进行补充说明，无外乎中英文互译一把，每个字段应该是什么含义。我们公司是使用手机号作为登录账户，所以本文中的account其实就是mobile手机号。每个人的手机号不可能相同，姓名却是可能相同的，故手机号满足cn和uid的唯一性要求。

其次，踩坑最多的地方就是Domain实体类的属性了。

@DnAttribute 和 @Attribute的区别
@Entry的属性值需要注意

最后，本文对ldap的用户操作，只是起一个抛砖引玉的作用，以供参考。

一、引入jar包

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-data-ldap</artifactId>
        </dependency>

二、配置

spring:
    ldap:
      urls: ldap://192.168.5.6:389
      base: dc=xxx,dc=com
      username: cn=admin,dc=xxx,dc=com
      password: 123456

三、源码实现

1、Domain

这里的@Entry属性base为 "ou=people"，全路径是"ou=people,dc=xxx,dc=com"，因为上面的配置已有spring.ldap.base，所以这里不需再冗余。


import com.fasterxml.jackson.annotation.JsonIgnore;
import lombok.Data;
import org.springframework.ldap.odm.annotations.Attribute;
import org.springframework.ldap.odm.annotations.DnAttribute;
import org.springframework.ldap.odm.annotations.Entry;
import org.springframework.ldap.odm.annotations.Id;

import javax.naming.Name;

/**
 * cn用于表示对象的名称，而uid用于表示用户的唯一标识符。
 * 因为它们都要求唯一性，所以我们让cn和uid为同一个，也作account，通常是手机号。
 */
@Data
@Entry(base = "ou=people",
        objectClasses = {"inetOrgPerson", "organizationalPerson", "person", "posixAccount"})
public class Person {

    @Id
    @JsonIgnore
    private Name id;

    /**
     * commonName（通用名称）用于指定对象的全名，通常用于表示人员、组织单位等实体的名称。
     * cn的值通常是该对象在目录中的唯一名称。
     */
    @DnAttribute(value = "cn", index = 1)
    private String cn;

    /**
     * uid（用户标识符）用于指定用户的唯一标识符。uid的值通常是用户的登录名或其他唯一标识符。
     */
    @Attribute(name = "uid")
    private String uid;

    /**
     * Last Name/Surname(姓氏)
     */
    @Attribute(name = "sn")
    private String sn;

    /**
     * 邮箱
     */
    @Attribute(name="mail")
    private String mail;

    /**
     * First Name/Given Name(名字)
     */
    @Attribute(name="givenName")
    private String givenName;

    /**
     * Full Name(姓+名)
     */
    @Attribute(name="description")
    private String description;

    /**
     * 登录密码
     */
    @Attribute(name="userPassword")
    private String userPassword;

    @Attribute(name="loginShell")
    private String loginShell;

    /**
     * posixAccount要求该属性
     */
    @Attribute(name="homeDirectory")
    private String homeDirectory;

    /**
     * posixAccount要求该属性
     */
    @Attribute(name="uidNumber")
    private String uidNumber;

    /**
     * posixAccount要求该属性
     */
    @Attribute(name="gidNumber")
    private String gidNumber;
}

2、Service

这里使用LdapTemplate类操作ldap的对象。

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.ldap.core.LdapTemplate;
import org.springframework.stereotype.Service;

@Service
public class LdapService {
    @Autowired
    private LdapTemplate ldapTemplate;

    private static final String DEFAULT_PASSWORD = "123456";
    private static final String LOGIN_SHELL = "/bin/bash";

    public void add(String sn, String givenName, String account, String mail){
        Person person = new Person();
        // 下面两个属性都是账号
        person.setCn(account);
        person.setUid(account);
        // Last Name/Surname(姓氏)
        person.setSn(sn);
        // First Name/Given Name(名字)
        person.setGivenName(givenName);
        // Full Name(姓+名)
        person.setDescription(sn + givenName);
        // 邮箱
        person.setMail(mail);
        person.setUserPassword(DEFAULT_PASSWORD);

        person.setLoginShell(LOGIN_SHELL);

        person.setHomeDirectory("/home/" + account);
        person.setUidNumber("10129");
        person.setGidNumber("10018");

        ldapTemplate.create(person);
    }
}

3、Controller

import cn.hutool.core.date.DateUtil;
import com.xxx.api.dto.PersonAddRequest;
import com.xxx.ldap.LdapService;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.http.ResponseEntity;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody;
import org.springframework.web.bind.annotation.RestController;

@Slf4j
@Api(value = "Ldap管理", tags = "Ldap管理")
@RestController
public class LdapApiController {
    @Autowired
    private LdapService ldapService;

    @ApiOperation(value = "新增用户")
    @PostMapping("/api/v1/ldap/person/add")
    public ResponseEntity<?> addPerson(@RequestBody PersonAddRequest request) {
        ldapService.add(request.getSn(), request.getGivenName(), request.getAccount(), request.getMail());
        return ResponseEntity.ok(DateUtil.now());
    }
}

四、请求示例

{
  "account": "18802129016",
  "givenName": "小明",
  "mail": "xxx@gmail.cn",
  "sn": "李"
}

五、LDAP界面

image.png

附

LdapTemplate.java还有对用户的修改、删除、查询等操作，本文就不再一一赘述。（有需要的时候，再补充~）