XMPP

Fluux XMPP

Fluux XMPP เป็น Chat SDK ใน Swift สำหรับ iOS, MacOS และ Linux ใช้โปรโตคอล XMPP ซึ่งเป็นมาตรฐาน IETF

Fluux XMPP เป็นการใช้งานแบบ Clean Slate โดยมีเป้าหมายต่อไปนี้:

• มุ่งเน้นไปที่ความเรียบง่าย โดยการซ่อนรายละเอียดทางเทคนิค XMPP และเปิดเผยเฉพาะวิธีการแชทเท่านั้น
• มุ่งเน้นไปที่ Swift สมัยใหม่ เวอร์ชัน iOS ล่าสุด และ XMPP สมัยใหม่ ไลบรารีจะละเว้นคุณลักษณะเดิมหรือที่เลิกใช้แล้วโดยตั้งใจ
• มุ่งเน้นไปที่การบำรุงรักษา XMPP เป็นโปรโตคอลที่ซับซ้อน และการบำรุงรักษาควรเป็นเกณฑ์หลักในการตัดสินใจออกแบบเพื่อให้สามารถยั่งยืนได้ในระยะยาว ด้วยเหตุผลเดียวกัน เรายังตั้งเป้าที่จะจำกัดการขึ้นต่อกันให้มากที่สุด
• มุ่งเน้นไปที่ประสิทธิภาพและความสามารถในการปรับขนาด โดยใช้ประโยชน์จากโปรโตคอล XMPP เพียงบางส่วนที่สามารถปรับขนาดได้ XEP จำนวนมากใช้งานมากเกินไปที่จะนำไปใช้ในการผลิตจำนวนมาก

ด้วยเหตุนี้ เราจึงกำหนดเป้าหมายเป็น iOS เวอร์ชัน 12+ บน iOS สำหรับ MacOS เรามุ่งเน้นไปที่ Mojave และสูงกว่า (10.14+) บน Linux เราใช้ซ็อกเก็ต BSD กับ SwiftNIO ดังนั้นจึงควรทำงานได้ค่อนข้างกว้าง ตราบใดที่คุณติดตั้ง Swift 5.0+ ไว้

หมายเหตุ : ไลบรารีนี้อยู่ระหว่างการพัฒนาอย่างแข็งขันและยังไม่พร้อมสำหรับการผลิต

การสร้างไลบรารี่ Fluux XMPP

เราออกแบบระบบการสร้างโดยมีหลักการดังต่อไปนี้:

• เป้าหมายคือการเป็นหลายแพลตฟอร์ม (iOS, MacOS, Linux) ในขณะที่ใช้คุณสมบัติใหม่ล่าสุดของ iOS และ MacOS
• เราต้องการความยืดหยุ่นและง่ายต่อการรวมเข้ากับเครื่องมือการจัดการการพึ่งพาที่สำคัญทั้งหมด (SwiftPM, CocoaPods, Carthage) อย่างไรก็ตาม SwiftPM ถือเป็นเป้าหมายหลักของเรา

ด้วยเหตุนี้ เราจึงสร้างแพลตฟอร์มที่แตกต่างกันตามเป้าหมาย / ระบบการสร้าง:

• ด้วย Carthage และ Cocoapods และ SwiftPM บน MacOS เราใช้ Apple Network.framework และกำหนดเป้าหมายไปที่ iOS 12+ และ MacOS 10.14+ หมายความว่าสำหรับ iOS มาตรฐานหรือ MacOS บิวด์ จะไม่มีการขึ้นต่อกันอื่นๆ
  • ด้วย SwiftPM บน Linux เราใช้ Swift-NIO เนื่องจาก Network.framework ใช้งานได้กับแพลตฟอร์ม Apple เท่านั้น

การตัดสินใจครั้งนี้ช่วยให้เราสามารถรักษาระบบการสร้างทั้งหมดให้เรียบง่าย ในขณะเดียวกันก็สามารถเข้าถึงแพลตฟอร์มที่ดีได้

การใช้แพ็คเกจ Swift

ติดตั้งการพึ่งพา homebrew

คุณต้องมีการใช้งาน libxml2 และ TLS (เช่น libressl) คุณสามารถติดตั้งด้วย HomeBrew:

brew install libxml2
brew install libressl

การเพิ่ม Fluux XMPP เป็นการพึ่งพาในโปรเจ็กต์ของคุณ

คุณสามารถสร้าง lib โดยใช้ Swift Package Manager ได้ด้วยไฟล์ Package.swift ที่ให้มา

คุณต้องกำหนดเป้าหมายการสร้างของคุณเป็น MacOS 10.12 อย่างชัดเจน เนื่องจากในขณะนี้ Swift PM ใช้ MacOS 10.10 เป็นค่าฮาร์ดโค้ดสำหรับเป้าหมายการปรับใช้ (เพิ่มเติมเกี่ยวกับสิ่งนี้ ที่นี่ )

หากต้องการรวม Fluux XMPP ในโปรเจ็กต์ Swift PM ของคุณ คุณสามารถเพิ่มเป็นการพึ่งพาโปรเจ็กต์ของคุณในไฟล์ Package.swift ได้ ตัวอย่างเช่น:

XMPPDemo", dependencies: [ // Dependencies declare other packages that this package depends on. .package(url: "https://github.com/FluuxIO/XMPP.git", from: "0.0.2"), ], targets: [ .target( name: " XMPP Demo", dependencies: [" XMPP "]), .testTarget( name: " XMPP DemoTests", dependencies: [" XMPP Demo"]), ] )">

// swift-tools-version:5.0

import PackageDescription

let package = Package (
    name : " XMPP Demo " ,
    dependencies : [
        // Dependencies declare other packages that this package depends on.
        . package ( url : " https://github.com/FluuxIO/XMPP.git " , from : " 0.0.2 " ) ,
    ] ,
    targets : [
        . target (
            name : " XMPP Demo " ,
            dependencies : [ " XMPP " ] ) ,
        . testTarget (
            name : " XMPP DemoTests " ,
            dependencies : [ " XMPP Demo " ] ) ,
    ]
)

คุณสามารถแก้ไขไฟล์ปฏิบัติการบรรทัดคำสั่ง main.swift เพื่อเริ่มไคลเอนต์ XMPP ตัวอย่างเช่น:

XMPP guard let jid = JID("mremond@localhost/ XMPP Demo") else { print("Invalid JID"); exit(1) } var XMPP Config = Config(jid: jid, password: "mypass", useTLS: true) XMPP Config.allowInsecure = true XMPP Config.host = "MacBook-Pro-de-Mickael.local" XMPP Config.streamObserver = DefaultStreamObserver() let client = XMPP (config: XMPP Config) let semaphore = DispatchSemaphore(value: 0) client.connect { print("Disconnected !") semaphore.signal() } _ = semaphore.wait(timeout: DispatchTime.distantFuture)">

import Foundation
import XMPP


guard let jid = JID ( " mremond@localhost/ XMPP Demo " ) else { print ( " Invalid JID " ) ; exit ( 1 ) }
var XMPP Config = Config ( jid : jid , password : " mypass " , useTLS : true )
XMPP Config . allowInsecure = true
XMPP Config . host = " MacBook-Pro-de-Mickael.local "
XMPP Config . streamObserver = DefaultStreamObserver ( )

let client = XMPP ( config : XMPP Config )

let semaphore = DispatchSemaphore ( value : 0 )
client . connect {
  print ( " Disconnected ! " )
  semaphore . signal ( ) 
}

_ = semaphore . wait ( timeout : DispatchTime . distantFuture )

ในการสร้างโปรเจ็กต์ คุณสามารถใช้คำสั่ง build มาตรฐาน:

swift build

จากนั้นคุณสามารถรันคอนโซลไคลเอ็นต์ของคุณได้:

.build/debug/ XMPP Demo

การทดสอบสามารถรันได้ด้วยคำสั่ง:

swift test

ทำงานบน Linux ด้วย Docker

คุณสามารถใช้อิมเมจอย่างเป็นทางการของ Docker เพื่อทำงานบนโปรเจ็กต์ Swift บน Linux คุณยังสามารถใช้ Docker บน MacO เพื่อสร้างเวอร์ชัน Linux ได้

คุณสามารถดึงข้อมูลอิมเมจ Swift Docker ได้ด้วยคำสั่งต่อไปนี้:

docker pull swift

จากนั้นคุณสามารถสร้างเชลล์ Linux แบบเปิดภายในคอนเทนเนอร์ได้:

docker run  -itv $( pwd ) :/code --name swiftcode -w /code swift /bin/bash

จากนั้นคุณจะต้องติดตั้งแพ็คเกจ libxml2-dev และ libssl-dev dev ในคอนเทนเนอร์ด้วย:

apt-get update
apt-get install libxml2-dev libssl-dev

จาก Docker Shell คุณสามารถสร้างโค้ดด้วย:

 swift build

หากต้องการรันการทดสอบบน Linux คุณต้องเปิดใช้งานการค้นพบการทดสอบอย่างชัดเจน (ดู Swift Test Discovery):

 swift test --enable-test-discovery

การสนับสนุน TLS

ในขณะนี้ ไลบรารีรองรับเฉพาะการเชื่อมต่อ TLS มาตรฐาน ไม่ใช่ STARTTLS ไลบรารี Apple Networking ไม่รองรับ (ยัง ?) การสลับการเข้ารหัสหลังจากสร้างการเชื่อมต่อแล้ว เพราะพวกเขากังวลกับปัญหาด้านความปลอดภัยที่อาจเกิดขึ้นเกี่ยวกับการใช้งาน STARTTLS

ดังที่กล่าวไปแล้ว XMPP รองรับ TLS บนพอร์ต 5223 ซึ่งเรียกว่า SSL "ดั้งเดิม" เนื่องจากการใช้พอร์ต 5223 ได้เลิกใช้แล้วโดย XMPP Standards Foundation มาระยะหนึ่งแล้ว ตามที่กล่าวไว้ เซิร์ฟเวอร์ XMPP สมัยใหม่ เช่น ejabberd รองรับ TLS ที่ทันสมัยบนพอร์ต 5223 หากต้องการใช้ TLS ในขณะนี้ การใช้ TLS บนพอร์ต 5223 ถือเป็นเรื่องดีอย่างยิ่ง