Chuyển đến tài liệu

THEO DÕI CUỘC TRÒ CHUYỆN

Hướng dẫn Sơ đồ tuần tự

Tạo tương tác API và dịch vụ theo thứ tự với đối tượng tham gia, lời gọi, phản hồi, nhánh và ghi chú.

Đối tượng tham gia và thông điệp → Sơ đồ tuần tựMở Sơ đồ tuần tự

Theo dõi cuộc trò chuyện

Sơ đồ tuần tự là một không gian làm việc trực quan độc lập cho các tương tác giữa con người, dịch vụ và hệ thống. Những người tham gia chạy từ trái sang phải; thời gian chạy xuống dưới trang. Dàn ý Luồng và sơ đồ hiển thị cùng một mô hình có thứ tự.

Chọn mẫu yêu cầu API để khám phá một client, API Đơn hàng, dịch vụ Xác thực và cơ sở dữ liệu. Mẫu này xác minh một token và sử dụng nhóm if/else để trả về các đơn hàng hoặc phản hồi không được ủy quyền. Chọn Sơ đồ trống để tự xây dựng cuộc hội thoại của riêng bạn.

Xây dựng một tương tác API

  1. Thêm các đối tượng tham gia cho Client và API. Chọn một đối tượng trong bảng Flow hoặc trên sơ đồ để chỉnh sửa tên, biểu tượng, màu sắc và thứ tự từ trái sang phải của nó.
  2. Khung vẽ trống hướng dẫn bạn qua các thành phần tham gia và thông điệp đầu tiên của bạn. Tên mới và văn bản thông điệp được chọn để bạn có thể nhập ngay lập tức. Chọn Thông điệp, sau đó chỉnh sửa Từ, Đến và Thông điệp trong Chi tiết. Thanh Thêm hiển thị nơi bước mới sẽ đi đến và ai gửi thông điệp. Một thông điệp được thêm sau bước đã chọn, trong cùng một nhánh. Việc chọn một thành phần tham gia sẽ bắt đầu thông điệp tiếp theo từ thành phần đó; một thông điệp được chọn sẽ cung cấp các điểm cuối của nó. Các ghi chú được thêm từ một thành phần tham gia đã chọn sẽ sử dụng điểm neo đó. Nếu không có bước nào được chọn, nó sẽ được thêm vào luồng chính.
  3. Chọn một thông báo và sử dụng Add reply after this message để đảo ngược các điểm cuối của nó và thêm một đường trả về nét đứt. Kéo các bước để đặt chúng theo thời gian; bản xem trước hiển thị điểm đến của chúng. Các điều khiển lên/xuống của Flow sắp xếp lại trong nhánh hiện tại.
  4. Sử dụng Nhóm → Nếu / khác, Tùy chọn, Vòng lặp hoặc Song song. Chọn một nhánh để chỉnh sửa điều kiện của nó hoặc thêm các bước ở đó. Thêm nhánh chèn trước khi dự phòng khác. Trong Luồng, mỗi nhánh có nút + riêng.
  5. Chạy Kiểm tra, xem lại sơ đồ và lưu hoặc xuất kết quả. Trên điện thoại, sử dụng các tab Luồng, Sơ đồ và Chi tiết; Chỉnh sửa chi tiết mở phần tử đã chọn và Quay lại sơ đồ để trở về khung vẽ.

Chọn, di chuyển và thêm trên sơ đồ

Nhấp vào tiêu đề hoặc đường đời của người tham gia, thông báo, ghi chú, đường viền nhóm hoặc vùng nhánh để chọn. Nhấn Enter hoặc Space để mở Chi tiết. Kéo tiêu đề người tham gia sang trái hoặc phải để điều chỉnh khoảng cách và thứ tự; kéo các thông báo, ghi chú hoặc toàn bộ nhóm theo chiều dọc để thiết lập thứ tự thời gian và tạo khoảng trống. Trên màn hình cảm ứng, hãy kéo phần tay cầm hiển thị; vuốt ở nơi khác để cuộn.

Bản xem trước hiển thị sơ đồ được đề xuất và đặt tên cho nhánh đích của nó. Thả vào một nhánh khác để chuyển một bước, hoặc sử dụng Di chuyển bước đến trong Chi tiết. Việc tạo và hủy vẫn nằm trong luồng chính; các nhóm không thể di chuyển vào bên trong chính chúng. Các thao tác kéo sẽ khớp vào 8 pixel. Thoát hoặc hủy sẽ để lại mô hình không thay đổi; việc thả chuột sẽ tạo ra một thay đổi có thể hoàn tác. Sắp xếp lại sẽ khôi phục khoảng cách tự động trong khi vẫn giữ nguyên thứ tự và các nhánh của bạn.

Nhấp vào thanh Thêm, hoặc trên máy tính để bàn, hãy kéo Người tham gia, Thông báo, Ghi chú hoặc một Nhóm vào sơ đồ. Các lựa chọn nhóm giải thích If / else, Optional, Loop và Parallel bằng ngôn ngữ đơn giản. Bản xem trước khi thả và chân trang canvas đặt tên cho nhánh đích và hiển thị vị trí của nó theo thời gian. Các thao tác kéo từ bảng màu bắt đầu với hai người tham gia đầu tiên; hướng di chuyển được hiển thị trong khi kéo. Chọn các điểm cuối của thông báo trong Chi tiết; việc thả gần một đường đời sẽ không thay đổi chúng.

Nhấp vào vùng trống trên canvas để xóa lựa chọn. Kéo vùng trống trên canvas hoặc sử dụng nút giữa chuột để khám phá trong khi vẫn giữ nguyên lựa chọn. Một nhóm có thể được thêm trước các người tham gia; trình giữ chỗ trên canvas và nút Flow + của nó sẽ thêm người tham gia đầu tiên, sau đó cung cấp thông báo đầu tiên.

Người tham gia và đường đời

Participant, Actor, Boundary, Control, Entity và Database thay đổi biểu tượng tiêu đề. Chúng là các vai trò trong một tương tác, không phải là các bảng cơ sở dữ liệu. Tên và màu nhấn hex mờ tùy chọn được lưu cùng với sơ đồ.

Kéo tiêu đề người tham gia để định vị; các tiêu đề gần đó sẽ di chuyển sang một bên để giữ cho văn bản dễ đọc. Di chuyển sang trái và Di chuyển sang phải sẽ hoán đổi vị trí của nó trong thứ tự hiển thị. Các điểm cuối của thông báo vẫn không thay đổi. Chi tiết người tham gia cung cấp các hành động Gửi tin nhắn và Thêm ghi chú. Một tin nhắn gửi cho cùng một người tham gia sẽ tự động trở thành một cuộc gọi tự thân; một sơ đồ có một người tham gia sẽ cung cấp điều này một cách rõ ràng. Việc xóa một người tham gia cũng sẽ xóa các tin nhắn liên quan đến người đó và xóa điểm neo của nó khỏi các ghi chú; Hoàn tác sẽ khôi phục toàn bộ thay đổi.

Cuộc gọi, phản hồi và vòng đời

Cuộc gọi, phản hồi và vòng đời
LoạiÝ nghĩa
Cuộc gọi đồng bộĐường liền nét và mũi tên đặc. Người gửi đợi thao tác được gọi.
Thông điệp không đồng bộĐường liền nét và mũi tên rỗng. Người gửi có thể tiếp tục mà không cần đợi.
Trả lời / trả vềĐường nét đứt quay trở lại người gọi. Thêm phản hồi sẽ đảo ngược các điểm cuối thông báo đã chọn.
Tạo người tham giaViệc tạo thuộc về tương tác đầu tiên của đường đời mục tiêu. Tiêu đề của nó bắt đầu tại thông báo này.
Hủy đối tượng tham giaDấu X đánh dấu sự hủy diệt của mục tiêu. Đây nên là tương tác cuối cùng của nó.
Việc tạo và hủy được hỗ trợ trong luồng chính, bên ngoài các phân đoạn. Các kiểm tra gắn cờ thứ tự vòng đời không nhất quán; thứ tự không hợp lệ giữ cho toàn bộ đường đời hiển thị để các tương tác sau đó không bị ẩn.

Nhóm các nhánh mà không làm mất ý nghĩa của chúng

If / else (alt) chứa 2–6 nhánh thay thế; chính xác một toán hạng khớp được chọn. Optional (opt) chứa một nhánh điều kiện. Loop chứa một nhánh lặp lại; viết điều kiện lặp. Parallel (par) chứa 2–6 toán hạng mà các tương tác của chúng có thể xen kẽ.

Tư cách thành viên nhánh là rõ ràng. Các nút luồng và Alt+Up/Down giữ một bước trong nhánh hiện tại của nó. Việc kéo thả có thể chuyển một thông báo, ghi chú hoặc toàn bộ nhóm sang nhánh được đặt tên trong bản xem trước; Di chuyển bước đến cung cấp lựa chọn tương tự trong Chi tiết. Các đích không hợp lệ bị vô hiệu hóa kèm theo lý do, bao gồm việc di chuyển một nhóm vào bên trong chính nó, vượt quá bốn cấp lồng nhau hoặc đặt việc tạo/hủy bên trong một nhánh.

Việc thay đổi một nhóm đa nhánh thành Tùy chọn (Optional) hoặc Vòng lặp (Loop) sẽ yêu cầu xác nhận trước khi chỉ giữ lại nhánh đầu tiên của nó. Việc xóa một nhánh sẽ yêu cầu xác nhận trước khi xóa các bước của nó; nếu còn lại một nhánh, nhóm sẽ trở thành Tùy chọn, và việc xóa nhánh duy nhất đó sẽ xóa cả nhóm. Việc xóa một nhóm sẽ xóa tất cả các bước của nó kèm theo xác nhận. Hoàn tác (Undo) sẽ khôi phục thay đổi hoàn chỉnh. Việc đặt các nhánh song song theo chiều dọc không ngụ ý thứ tự thực thi giữa chúng.

Ghi chú, đánh số và kích hoạt

Thêm một ghi chú và chọn các đối tượng tham gia mà nó sẽ bao phủ. Các ghi chú gói gọn trong khung của chúng và di chuyển theo thứ tự tuần tự. Sử dụng chúng cho các ràng buộc hoặc giải thích thay vì đặt một đoạn văn trên mũi tên thông báo.

Các điều khiển xem quản lý số thứ tự tin nhắn và thanh kích hoạt tự động. Các tùy chọn hiển thị này được lưu và bao gồm trong xuất hình ảnh. Các con số cung cấp thứ tự đọc; chúng không phải là dấu thời gian được đo lường hoặc tổng thứ tự thực thi trên các nhánh song song.

Các thanh kích hoạt được suy ra từ các cuộc gọi đồng bộ và các phản hồi được vẽ. Các cuộc gọi tự thân có thể lồng nhau. Các nhánh thay thế được tính toán riêng biệt để các phản hồi trong một nhánh không đóng các cuộc gọi trong nhánh khác. Các phản hồi bị thiếu để lại một kích hoạt mở cho đến cuối phạm vi đó; đây là một công cụ hỗ trợ trực quan thay vì phân tích thực thi.

Các sơ đồ mới bắt đầu ở tỷ lệ dễ đọc; các sơ đồ rộng có thể cuộn theo chiều ngang. Tính năng vừa chiều rộng sơ đồ cung cấp cái nhìn tổng quan trong khi vẫn giữ nguyên cách đọc theo chiều dọc. Cuộn để khám phá, sử dụng các điều khiển thu phóng hoặc nhấn Ctrl/Command kết hợp cuộn để thu phóng xung quanh con trỏ. Tìm kiếm sẽ tìm tên và loại thành phần tham gia, thông điệp và điểm cuối của chúng, ghi chú, mô tả nhóm và điều kiện. Các bước khớp giữ lại ngữ cảnh nhánh liên quan của chúng; ID và vị trí bị loại trừ. Xóa hoặc nhấn Escape sẽ khôi phục toàn bộ Luồng, và kết quả trống sẽ giải thích những gì cần thử. Việc chọn một kết quả Luồng hoặc Kiểm tra, hoặc thêm một phần tử, sẽ đưa nhãn của nó vào tầm nhìn mà không thay đổi mức thu phóng. Trên điện thoại, điều này xảy ra khi bạn quay lại Sơ đồ. Việc cuộn, thu phóng và lựa chọn trên khung vẽ là các chế độ xem không gian làm việc nằm ngoài tài liệu và lịch sử Hoàn tác.

Lưu, chia sẻ và nhập

Các sơ đồ mới vẫn nằm trong bộ nhớ. Lưu sẽ đăng nhập khi cần và tạo một tệp đám mây sơ đồ tuần tự độc lập. Tệp → Mở sơ đồ tuần tự sẽ mở danh sách tệp của riêng nó. Lưu các thay đổi mới nhất trước khi chia sẻ liên kết công khai chỉ đọc. Người xem công khai có thể kiểm tra và xuất nhưng không thể chỉnh sửa tệp.

Tệp → Tải xuống JSON giữ lại tài liệu có thể chỉnh sửa hoàn chỉnh, bao gồm vị trí các thành phần và khoảng cách bước. Các bản lưu trên đám mây và xuất hình ảnh cũng giữ lại vị trí này. Nhập JSON chấp nhận các tệp sơ đồ tuần tự Erd Go phiên bản 1 đã xuất lên đến 4 MB, xác thực toàn bộ tệp trước khi thay thế và hỗ trợ Hoàn tác. Các tệp cũ hơn giữ lại khoảng cách tự động; các vị trí nhập bị chồng lấp được hiển thị an toàn. SQL, Sơ đồ lớp, Mermaid và PlantUML không phải là các định dạng nhập.

Tệp → Sơ đồ mới mở lại bộ chọn Trống/Mẫu. Trống và ví dụ yêu cầu API thay thế mô hình hiện có bằng xác nhận và Hoàn tác. Các sơ đồ chưa lưu sẽ nhắc trước khi rời đi hoặc tải lại. Không có gì được ghi vào bộ nhớ trình duyệt.

Xuất sơ đồ hoặc nguồn văn bản

Xuất tạo ra PNG, JPEG, WebP, SVG vector độc lập hoặc PDF có hỗ trợ hình ảnh. Chọn Toàn bộ sơ đồ hoặc Chế độ xem hiện tại (mở bảng Sơ đồ trước trên điện thoại) và chiều rộng HD, 2K hoặc 4K. Kích thước raster bị giới hạn ở 8192 pixel mỗi cạnh và 16 megapixel; các sơ đồ rất cao có thể bị thu nhỏ. Sử dụng SVG cho các sơ đồ lớn có thể mở rộng hoặc Chế độ xem hiện tại cho một phần có thể đọc được.

Tệp → Xuất PlantUML / Mermaid xem trước, sao chép và tải xuống văn bản cục bộ. Trình kết xuất văn bản kiểm soát bố cục và giao diện của riêng nó; các biểu tượng hoặc màu sắc của thành phần có thể khác nhau. JSON là định dạng có thể chỉnh sửa hoàn chỉnh. Không có nguồn nào được gửi đến máy chủ kết xuất của bên thứ ba.

Mermaid / Ví dụ văn bản luồng yêu cầu API
sequenceDiagram
participant Client
participant API
participant Auth
participant Database
Client ->> API: GET /orders
API ->> Auth: verify token
Auth -->> API: identity
alt valid token
  API ->> Database: SELECT orders
  Database -->> API: orders[]
  API -->> Client: 200 OK
else invalid token
  API -->> Client: 401 Unauthorized
end
Xây dựng luồng này một cách trực quan hoặc sử dụng mẫu yêu cầu API. Ví dụ minh họa việc xuất văn bản; nó không thể được nhập vào Erd Go.

Phím tắt và giới hạn

Phím tắt và giới hạn
Hành động hoặc giới hạnHành vi
Ctrl/Cmd+SLưu vào đám mây; đăng nhập khi được nhắc.
Ctrl/Cmd+KMở và tập trung vào Tìm kiếm trong bảng điều khiển Luồng.
Ctrl/Cmd+Z / Shift+Z / Ctrl+YHoàn tác / Làm lại bên ngoài các trường văn bản. Các trường văn bản giữ lại các phím tắt chỉnh sửa gốc.
Enter / Dấu cáchMở Chi tiết cho phần tử sơ đồ đang được chọn.
Alt+Trái / PhảiDi chuyển người tham gia đã chọn sang trái hoặc phải.
Alt+Lên / XuốngDi chuyển bước đã chọn trong nhánh hiện tại của nó.
Xóa / BackspaceXóa lựa chọn bên ngoài các trường văn bản, hoặc sử dụng nút thùng rác trên khung vẽ. Việc xóa đối tượng tham gia theo chuỗi và xóa nhóm/nhánh sẽ yêu cầu xác nhận.
Phím Escape trong khi kéoHủy bản xem trước mà không thay đổi mô hình.
Dọn dẹpKhôi phục khoảng cách tự động mà không thay đổi thứ tự hoặc nhánh; Hoàn tác sẽ khôi phục vị trí.
Người tham gia và các bước30 người tham gia và tổng cộng 300 bước, bao gồm các đoạn và ghi chú.
Văn bản80 ký tự cho mỗi tên người tham gia, 240 cho mỗi nhãn tin nhắn/điều kiện/nhóm, 2.000 cho mỗi ghi chú.
Tệp và lịch sửTệp JSON nhập vào 4 MB, tên tệp trên đám mây từ 3–255 ký tự và 80 trạng thái hoàn tác.

Xem lại và khắc phục sự cố

Các kiểm tra sẽ gắn cờ các tên trống, tên người tham gia trùng lặp, nhãn thông báo bị thiếu, nhánh trống, điều kiện bị thiếu và thứ tự tạo hoặc hủy không nhất quán. Chọn một kết quả tìm thấy để hiển thị Chi tiết của nó. Các kiểm tra này không thực thi cuộc hội thoại hoặc chứng minh hành vi API.

Nếu việc nhập thất bại, sơ đồ hiện tại của bạn vẫn còn nguyên vẹn. Một tệp đang chờ xử lý cũ hơn không thể thay thế tài liệu mới hơn, tệp nhập mới hơn hoặc mô hình đã chỉnh sửa. Nếu việc lưu trên đám mây thất bại, hãy giữ sơ đồ mở và tải xuống JSON trước khi rời đi.

Sử dụng đặc tả OMG UML cho ý nghĩa của ký hiệu tương tác. PlantUML và Mermaid có cú pháp văn bản riêng; các tệp được tạo là các tệp xuất cho các công cụ đó, không phải là ngôn ngữ nhập của Erd Go.