XPages 的 NotesName:getCommonUserName 省一步,比對還是要正規化

XPages 的 NotesName:getCommonUserName 省一步,比對還是要正規化

2026.11.17 約 670 字

在 XPages 要顯示登入者的名字,常見的寫法是 session.createName(session.getUserName()).getCommon()——建一個 NotesName、再要它的 common 名。

其實不用繞這一圈。session 本身就有捷徑:getCommonUserName() 一步給你登入者的 common 名,getUserNameObject() 直接給你一個 NotesName 物件。這是 XPages 比後端 Java 方便的地方。

但有一件事 XPages 省不掉:只要牽涉到比對——比對簽核人、或用 OU 決定某個區塊給不給看——就會踩「同一個人,canonical 和 abbreviated 不相等」的坑。這篇講 session 的名字捷徑、XPages 裡怎麼正確比對與判斷 OU,以及存進 Readers 欄位該用哪種形式。


顯示:session 的名字捷徑

NotesSession 直接給了幾個關於「目前這個使用者」的現成值,不用自己 createName:

  • session.getCommonUserName()——官方「The common name of the user that created the session.」。要在頁面上顯示「你好,John B Goode」用這個。
  • session.getUserNameObject()——官方「The name, in the form of a NotesName object, of the user or server that created the session.」。要進一步拆 OU、要 canonical 形式時,直接拿這個 NotesName 物件來用,連 getUserName() 再 createName 都省了。
  • session.getUserName()(完整名)、session.getEffectiveUserName()(login 名)備用。

顯示登入者自己,走這幾個捷徑最乾淨。要處理「別人的」名字(文件裡的欄位值)才用 session.createName(那個值)。

比對:XPages 也省不掉正規化

這是從後端 Java 一路到 XPages 都一樣的坑。文件裡存的簽核人可能是 abbreviated 的 John B Goode/Acme,登入者 getUserName() 給的是 canonical 的 CN=John B Goode/O=Acme——同一個人,字串比卻不相等。正解一樣是兩邊都正規化:

var me = session.getUserNameObject(); // 已經是 NotesName
var him = session.createName(doc.getItemValueString("Approver"));
var same = me.getCanonical().equalsIgnoreCase(him.getCanonical());

這個正規化的來龍去脈,在 Java 的 Name 那篇 講得更細——同一個邏輯,SSJS 照用。

用 OU 做條件可見性

XPages 常見需求:某個區塊只給某個組織單位的人看,綁在 rendered 上。這裡別用 contains("Sales")——名字裡剛好有 Sales 的人會被誤放進來。用 getOrgUnit1() 精準比那一段:

// 某個 panel 的 rendered 屬性
var ou = session.getUserNameObject().getOrgUnit1();
"Sales".equalsIgnoreCase(ou);

NotesName 的各段都是現成的:getOrganization()(O=)、getOrgUnit1() 到 getOrgUnit4()(OU=)、getCountry()(C=)。

存進 Readers 欄位要用 canonical

一個相關的實務點:如果你在 XPages 把名字寫進 Readers / Authors 欄位(控制誰看得到文件),存的應該是 canonical 形式。Readers 欄位比對的是完整階層名;存了 abbreviated 或 common,可能比不中、或誤放行。寫入前先 createName(...).getCanonical() 正規化。Readers/Authors 欄位的行為見 Readers 與 Authors 欄位那篇。

同類別在其他語言

同一個 Name:

  • LotusScript:NotesName,Common / Canonical / OrgUnit1 等屬性都在;格式細節見 NotesName 格式那篇。
  • Java:Name,API 相同;比對 bug 與正規化的完整說明見 Java 的 Name 那篇,但 Java 沒有 XPages 的 session.getCommonUserName() 這種「目前使用者」捷徑。
  • SSJS 專屬的不是 API(方法共用),而是 NotesSession 在 XPages 提供的 getCommonUserName() / getUserNameObject() 這些「目前登入者」的現成值——顯示自己時省一步,但一碰到比對,canonical≠abbreviated 的坑照樣在。

參考來源

← 回到文章列表