Spring Ldap

此篇关于Spring LDAP的使用，主要偏向于简单的DEMO，后续会根据实际项目需求再进行修改正。
这篇文章是我鼓起勇气发布的第一篇文章，有一些问题或者错误理解，请提出改正，谢谢！

一、）Ldap的一些简单缩写介绍

1、这是我们自己搭建的open ldap的结构，可以看到里面有几个重要的缩写：DC、OU、CN、DN

关键字	英文名称	含义
DC	domainComponent	域名的部分，其格式是将完整的域名分成几部分，如域名为example.com变成dc=example,dc=com（一条记录的所属位置）
OU	Organization Unit	组织单位，组织单位可以包含其他各种对象（包括其他组织单元），如“oa组”
CN	common name	公共名称，如“lichunlan”（一条记录的名称）
DN	Distinguished Name	“cn=lichunlan,ou=people,dc=example,dc=com”，一条记录的位置（唯一）

image.png

2、objectClass

结构型（Structural）：如account、inetOrgPerson、person和organizationUnit；
辅助型（Auxiliary）：如extensibeObject；
抽象型（Abstract）：如top，抽象型的objectClass不能直接使用。
规定了就是说指定为特定的objectClass之后，有些属性就是必须要有的例如，account就要求userid是必填项，而inetOrgPerson则要求cn(common name,常用名称)和sn(sure name,真实名称)是必填项。

image.png

二、）SpringBoot ldap的具体使用

1、简单结构

image.png

2、pom.xml

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

3、application.properties

#这里有一个坑，我们自己搭建openldap，浏览器访问的地址是http://IP:81/ ，
# 我在研究的时候，spring.ldap.urls=ldap://IP:81   spring.ldap.urls=http://IP:81  都提示url不对，
# 最后把默认81端口去掉才OK的spring.ldap.urls=ldap://IP
spring.ldap.urls=ldap://IP
spring.ldap.base= dc=lets,dc=com
spring.ldap.username= cn=lichunlan,ou=people,dc=lets,dc=com
spring.ldap.password=*******
server.port= 9999

4、Person.class

package com.example.ldap.entry;

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;

/**
 * @author lichunlan
 * @description
 * @since 2020-01-20
 */
@Data
@Entry(objectClasses = {"inetOrgPerson","top"})

public class Person {
    /**
     * 唯一标识名
     */
    @Id
    @JsonIgnore
    private Name dn;

    /**
     * 常用名称
     */
    @Attribute(name="cn")
    private String cn;

    /**
     * 用户标识
     */
    @Attribute(name="uid")
    private String userName;

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

    /**
     *真实名称
     */
    @Attribute(name="sn")
    private String sn;


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

    /**
     * 组织
     */
    @DnAttribute("ou")
    private String ou;
    /**
     */
    @Attribute(name = "mobile")
    private String mobile;


    /**
     * 机构名称
     */
    @DnAttribute("ou")
    private String orgId;


    @Override
    public String toString() {
        return "Person{" +
                "dn=" + dn.toString() +
                ", cn='" + cn + '\'' +
                ", sn='" + sn + '\'' +
                ", userPassword='" + userPassword + '\'' +
                '}';
    }
}

5、LdapServices.class

package com.example.ldap.services;

import com.example.ldap.entry.Person;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.ldap.core.LdapTemplate;
import org.springframework.ldap.query.LdapQueryBuilder;
import org.springframework.stereotype.Service;

import java.util.List;

/**
 * @author lichunlan
 * @description
 * @since 2020-01-20
 */
@Service
public class LdapServices {
    @Autowired
    private LdapTemplate ldapTemplate;

    public List<Person> getAllPersonNames() {
        return ldapTemplate.findAll(Person.class);
    }


    public Person findByCn(String cn){
        return ldapTemplate.findOne(LdapQueryBuilder.query().where("cn").is(cn),Person.class);
    }


}

6、testController.class

package com.example.ldap.controller;

import com.example.ldap.entry.Person;
import com.example.ldap.services.LdapServices;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

import java.util.List;

/**
 * @author lichunlan
 * @description
 * @since 2020-01-20
 */
@RestController
public class testController {
    @Autowired
    private LdapServices ldapServices;

    @RequestMapping(value = "/findOne",method = RequestMethod.GET)

    public Person findByCn(@RequestParam(name = "cn",required = true) String cn){
        return ldapServices.findByCn(cn);
    }

    @RequestMapping(value = "/findAllPersion",method = RequestMethod.GET)
    public List<Person> findAllPersion(){
        return ldapServices.getAllPersonNames();
    }
}

7、使用postMan进行接口测试

7.1、findOne（获取某个账号的信息）

image.png

7.2、findAllPersion（获取Ou下的所有信息）

image.png

因为我们的项目具体是只需要获取客户的所有人员信息，所有没有测试新增、编辑、删除这几个，有需求的人自行使用ldapTemplate中的一些方法即可
这里目前只有一个ou,实际项目中是会有多个ou的，所以年后开工的时候，我会把多个ou下的信息补齐，并进行验证。到时候再进行文档更新