Spring Boot 2.x基礎(chǔ)教程：使用LDAP來管理用戶與組織數(shù)據(jù)
很多時(shí)候，我們?cè)谧龉鞠到y(tǒng)或產(chǎn)品時(shí)，都需要自己創(chuàng)建用戶管理體系，這對(duì)于開發(fā)人員來說并不是什么難事，但是當(dāng)我們需要維護(hù)多個(gè)不同系統(tǒng)并且相同用戶跨系統(tǒng)使用的情況下，如果每個(gè)系統(tǒng)維護(hù)自己的用戶信息，那么此時(shí)用戶信息的同步就會(huì)變的比較麻煩，對(duì)于用戶自身來說也會(huì)非常困擾，很容易出現(xiàn)不同系統(tǒng)密碼不一致啊等情況出現(xiàn)。
如果此時(shí)我們引入LDAP來集中存儲(chǔ)用戶的基本信息并提供統(tǒng)一的讀寫接口和校驗(yàn)機(jī)制，那么這樣的問題就比較容易解決了。尤其在一些內(nèi)部管理系統(tǒng)的開發(fā)和搭建時(shí)，往往我們的內(nèi)部系統(tǒng)一開始并不全是自己開發(fā)的，還有很多第三方產(chǎn)品支持，比如：OA系統(tǒng)、財(cái)務(wù)系統(tǒng)等，如果自己開發(fā)一套用戶管理系統(tǒng)，那么這些系統(tǒng)對(duì)接還得二次開發(fā)，成本很大。由于LDAP并不是什么新技術(shù)，大部分成熟軟件都支持用LDAP來管理用戶，所以時(shí)至今日，LDAP的應(yīng)用依然可以經(jīng)?？吹健?/p>
下面我們就具體來看看，當(dāng)使用Spring Boot開發(fā)的時(shí)候，如何來訪問LDAP服務(wù)端。
LDAP簡(jiǎn)介
LDAP（輕量級(jí)目錄訪問協(xié)議，Lightweight Directory Access Protocol)是實(shí)現(xiàn)提供被稱為目錄服務(wù)的信息服務(wù)。目錄服務(wù)是一種特殊的數(shù)據(jù)庫(kù)系統(tǒng)，其專門針對(duì)讀取，瀏覽和搜索操作進(jìn)行了特定的優(yōu)化。目錄一般用來包含描述性的，基于屬性的信息并支持精細(xì)復(fù)雜的過濾能力。目錄一般不支持通用數(shù)據(jù)庫(kù)針對(duì)大量更新操作操作需要的復(fù)雜的事務(wù)管理或回卷策略。而目錄服務(wù)的更新則一般都非常簡(jiǎn)單。這種目錄可以存儲(chǔ)包括個(gè)人信息、web鏈結(jié)、jpeg圖像等各種信息。為了訪問存儲(chǔ)在目錄中的信息，就需要使用運(yùn)行在TCP/IP 之上的訪問協(xié)議—LDAP。
LDAP目錄中的信息是是按照樹型結(jié)構(gòu)組織，具體信息存儲(chǔ)在條目(entry)的數(shù)據(jù)結(jié)構(gòu)中。條目相當(dāng)于關(guān)系數(shù)據(jù)庫(kù)中表的記錄；條目是具有區(qū)別名DN （Distinguished Name）的屬性（Attribute），DN是用來引用條目的，DN相當(dāng)于關(guān)系數(shù)據(jù)庫(kù)表中的關(guān)鍵字（Primary Key）。屬性由類型（Type）和一個(gè)或多個(gè)值（Values）組成，相當(dāng)于關(guān)系數(shù)據(jù)庫(kù)中的字段（Field）由字段名和數(shù)據(jù)類型組成，只是為了方便檢索的需要，LDAP中的Type可以有多個(gè)Value，而不是關(guān)系數(shù)據(jù)庫(kù)中為降低數(shù)據(jù)的冗余性要求實(shí)現(xiàn)的各個(gè)域必須是不相關(guān)的。LDAP中條目的組織一般按照地理位置和組織關(guān)系進(jìn)行組織，非常的直觀。LDAP把數(shù)據(jù)存放在文件中，為提高效率可以使用基于索引的文件數(shù)據(jù)庫(kù)，而不是關(guān)系數(shù)據(jù)庫(kù)。類型的一個(gè)例子就是mail，其值將是一個(gè)電子郵件地址。
LDAP的信息是以樹型結(jié)構(gòu)存儲(chǔ)的，在樹根一般定義國(guó)家(c=CN)或域名(dc=com)，在其下則往往定義一個(gè)或多個(gè)組織 (organization)(o=Acme)或組織單元(organizational units) (ou=People)。一個(gè)組織單元可能包含諸如所有雇員、大樓內(nèi)的所有打印機(jī)等信息。此外，LDAP支持對(duì)條目能夠和必須支持哪些屬性進(jìn)行控制，這是有一個(gè)特殊的稱為對(duì)象類別(objectClass)的屬性來實(shí)現(xiàn)的。該屬性的值決定了該條目必須遵循的一些規(guī)則，其規(guī)定了該條目能夠及至少應(yīng)該包含哪些屬性。例如：inetorgPerson對(duì)象類需要支持sn(surname)和cn(common name)屬性，但也可以包含可選的如郵件，電話號(hào)碼等屬性。
LDAP簡(jiǎn)稱對(duì)應(yīng)
o：organization（組織-公司） ou：organization unit（組織單元-部門） c：countryName（國(guó)家） dc：domainComponent（域名） sn：surname（姓氏） cn：common name（常用名稱）
入門示例
在了解了LDAP的基礎(chǔ)概念之后，我們通過一個(gè)簡(jiǎn)單例子進(jìn)一步理解！
創(chuàng)建一個(gè)基礎(chǔ)的Spring Boot項(xiàng)目（如果您還不會(huì)，可以參考這篇文章：快速入門1） 在 pom.xml中引入兩個(gè)重要依賴
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-data-ldap</artifactId>
</dependency>
<dependency>
<groupId>com.unboundid</groupId>
<artifactId>unboundid-ldapsdk</artifactId>
<scope>test</scope>
</dependency>
其中，spring-boot-starter-data-ldap是Spring Boot封裝的對(duì)LDAP自動(dòng)化配置的實(shí)現(xiàn)，它是基于spring-data-ldap來對(duì)LDAP服務(wù)端進(jìn)行具體操作的。
而unboundid-ldapsdk主要是為了在這里使用嵌入式的LDAP服務(wù)端來進(jìn)行測(cè)試操作，所以scope設(shè)置為了test，實(shí)際應(yīng)用中，我們通常會(huì)連接真實(shí)的、獨(dú)立部署的LDAP服務(wù)器，所以不需要此項(xiàng)依賴。
在 src/test/resources目錄下創(chuàng)建ldap-server.ldif文件，用來存儲(chǔ)LDAP服務(wù)端的基礎(chǔ)數(shù)據(jù)，以備后面的程序訪問之用。
dn: dc=didispace,dc=com
objectClass: top
objectClass: domain
objectclass: extensibleObject
dc: didispace
dn: ou=people,dc=didispace,dc=com
objectclass: top
objectclass: organizationalUnit
ou: people
dn: uid=ben,ou=people,dc=didispace,dc=com
objectclass: top
objectclass: person
objectclass: organizationalPerson
objectclass: inetOrgPerson
cn: didi
sn: zhaiyongchao
uid: didi
userPassword: {SHA}nFCebWjxfaLbHHG1Qk5UU4trbvQ=
這里創(chuàng)建了一個(gè)基礎(chǔ)用戶，真實(shí)姓名為zhaiyongchao，常用名didi，在后面的程序中，我們會(huì)來讀取這些信息。更多內(nèi)容解釋大家可以深入學(xué)習(xí)LDAP來理解，這里不做過多的講解。
在 application.properties中添加嵌入式LDAP的配置
spring.ldap.embedded.ldif=classpath:ldap-server.ldif
spring.ldap.embedded.base-dn=dc=didispace,dc=com
使用spring-data-ldap的基礎(chǔ)用法，定義LDAP中屬性與我們Java中定義實(shí)體的關(guān)系映射以及對(duì)應(yīng)的Repository
@Data
@Entry(base = "ou=people,dc=didispace,dc=com", objectClasses = "inetOrgPerson")
public class Person {
@Id
private Name id;
@DnAttribute(value = "uid", index = 3)
private String uid;
@Attribute(name = "cn")
private String commonName;
@Attribute(name = "sn")
private String userName;
private String userPassword;
}
public interface PersonRepository extends CrudRepository<Person, Name> {
}
通過上面的定義之后，已經(jīng)將Person對(duì)象與LDAP存儲(chǔ)內(nèi)容實(shí)現(xiàn)了映射，我們只需要使用PersonRepository就可以輕松的對(duì)LDAP內(nèi)容實(shí)現(xiàn)讀寫。
創(chuàng)建單元測(cè)試用例讀取所有用戶信息：
@Slf4j
@SpringBootTest
public class ApplicationTests {
@Autowired
private PersonRepository personRepository;
@Test
public void findAll() {
personRepository.findAll().forEach(p -> {
System.out.println(p);
});
}
}
啟動(dòng)該測(cè)試用例之后，我們可以看到控制臺(tái)中輸出了剛才維護(hù)在ldap-server.ldif中的用戶信息：
Person(id=uid=ben,ou=people,dc=didispace,dc=com, uid=ben, commonName=didi, userName=zhaiyongchao, userPassword=123,83,72,65,125,110,70,67,101,98,87,106,120,102,97,76,98,72,72,71,49,81,107,53,85,85,52,116,114,98,118,81,61)
添加用戶
通過上面的入門示例，如果您能夠獨(dú)立完成，那么在Spring Boot中操作LDAP的基礎(chǔ)目標(biāo)已經(jīng)完成了。
如果您足夠了解Spring Data，其實(shí)不難想到，這個(gè)在其下的子項(xiàng)目必然也遵守Repsitory的抽象。所以，我們可以使用上面定義的PersonRepository來輕松實(shí)現(xiàn)操作，比如下面的代碼就可以方便的往LDAP中添加用戶：
Person person = new Person();
person.setUid("uid:1");
person.setSuerName("AAA");
person.setCommonName("aaa");
person.setUserPassword("123456");
personRepository.save(person);
如果還想實(shí)現(xiàn)更多操作，您可以參考spring-data-ldap的文檔來進(jìn)行使用。
連接LDAP服務(wù)端
在本文的例子中都采用了嵌入式的LDAP服務(wù)器，事實(shí)上這種方式也僅限于我們本地測(cè)試開發(fā)使用，真實(shí)環(huán)境下LDAP服務(wù)端必然是獨(dú)立部署的。
在Spring Boot的封裝下，我們只需要配置下面這些參數(shù)就能將上面的例子連接到遠(yuǎn)端的LDAP而不是嵌入式的LDAP。
spring.ldap.urls=ldap://localhost:1235
spring.ldap.base=dc=didispace,dc=com
spring.ldap.username=didispace
spring.ldap.password=123456
關(guān)注我，后面更新如何與Spring Security結(jié)合使用！
本系列教程《Spring Boot 2.x基礎(chǔ)教程》：http://blog.didispace.com/spring-boot-learning-2x/
代碼示例
本文的相關(guān)例子可以查看下面?zhèn)}庫(kù)中的chapter2-8目錄：
Github：https://github.com/dyc87112/SpringBoot-Learning/ Gitee：https://gitee.com/didispace/SpringBoot-Learning/
往期推薦
學(xué)習(xí)過程中如遇困難，建議加入Spring技術(shù)交流群，參與交流與討論，更好的學(xué)習(xí)與進(jìn)步！如何加入？點(diǎn)擊下方卡片，回復(fù)關(guān)鍵詞「加群」即可！