使用 Sublime + PlantUML 高效地画图：业务流程图、业务时序图、架构组件图 等

文章出处，原创于 https://HawkingOuYang.github.io/

我的GitHub

---

Sublime + PlantUML

使用 Sublime + PlantUML 高效地画图: 流程图、时序图、状态图、活动图、思维导图 等等。

使用 Sublime + PlantUML 高效地画图

Sublime Text (3103版本可用) 注册码 License Key

【链接】ProcessOn-免费在线作图，实时协作

上周无法使用plantuml的问题找到了
需要重新安装graphviz，终端执行

brew link --overwrite graphviz

Sublime + PlantUML

1.安装sublimetext

2.安装graphviz

brew install graphviz

3.安装 PlantUML for Sublime 插件

cd ~/Library/Application\ Support/Sublime\ Text\ 3/Packages

git clone https://github.com/jvantuyl/sublime_diagram_plugin.git

4.安装java

wget http://javadl.oracle.com/webapps/download/AutoDL\?BundleId\=211990 -O jre-8u101-macosx-x64.dmg

open jre-8u101-macosx-x64.dmg

export JAVA_HOME=/Library/Internet\ Plug-Ins/JavaAppletPlugin.plugin/Contents/Home/

推荐把JAVA_HOME环境变量加入~/.zshrc

5.设置sublime 快捷键
打开 Preferences -> Key Binding - User，添加一个快捷键：

{ "keys": ["alt+d"], "command": "display_diagrams"}

上面的代码配置成按住 Alt + d 来生成 PlantUML 图片，你可以修改成你自己喜欢的按键。

6.下载PlantUML文档
http://plantuml.com/PlantUML_Language_Reference_Guide.pdf

建立 软链接

ln -s '/Applications/Sublime Text.app/Contents/SharedSupport/bin/subl'  /usr/local/bin/subl

强制 替换 软链接

ln -s -f '/Applications/Sublime Text 3.app/Contents/SharedSupport/bin/subl'  /usr/local/bin/subl

举个例子

.

@startuml
title: 合并云端联系人-业务流程(OYXJ on 2016.09.20)
start


:app启动;

partition 登入状态 {
	if (本地有token?) then (no)

		while (登录成功?) is (failure)
			:重新登录;
		endwhile (success)	
				
	else (yes)

		if (验证token?) then (token有效)

		else (token失效)
			while (重新登录?) is (登录失败)
				:重新登录;
			endwhile (登录成功)
		endif

	endif
}


partition 系统通讯录授权状态 {
	if (App安装之后，第一次 询问用户“通讯录授权”？) then (是 第一次)
		:弹窗让用户选择是否授权;
			note right
				这个弹窗由iOS操作系统提供
			end note

	else (不是 第一次)
		:在联系人列表页面 提示用户去“设置”进行授权;
		if (用户前往“设置” 改变“App访问系统通讯录的权限”?) then (yes)
			:app将被terminate;
			stop
		else (no)
			:联系人页面显示“通讯录尚未授权”;
		endif
	endif
}		


if (系统通讯录已经授权?) then (yes)
	
	fork

	if (本地数据库CoreData有HomeTime联系人数据) then (yes)
		:在联系人列表显示HomeTime联系人;
	else (no)
		:在联系人列表显示占位图片;
			note right
				TODO: 
				目前没有显示展位图片，或者，没有loading；
				目前只是一个空的列表
			end note
	endif

	fork again

	:拉取服务端所有HomeTime联系人数据;
		note right	
			1、帐号之前登录过设备A、B等，
				然后把设备A、B的HomeTime联系人数据 上传到了云端。
			2、帐号登录(首次)设备C，此时需要下载之前 设备A、B 上传到云端的数据。
			3、目的在于，让用户能够迅速看到数据，
			4、但是这里存在一个问题：这些数据在内存中，如果用户此时(详情页面)修改数据？？
		end note

	#AAAAAA:此线程发出信号量 dispatch_semaphore_t;

	detach

	end fork


	partition 系统通讯录数据与服务端数据交互 {

		:获取系统通讯录的所有手机号码;

		partition 本机(即iPhone设备)HomeTime联系人 {
			:手机号码交给服务端匹配支持HomeTime;
				note left
					1、分批 提交数据 给服务端，匹配支持HomeTime
					2、每一批 150个 手机号码
					3、单线程处理，这个网络请求Response之前，'不能'发起第二个请求
					4、所有 批次的 网络Response数据，依然 单线程 写入CoreData数据库
					5、TODO：这里需要优化，为了让用户迅速看到数据，是否 从服务端得到一批数据，则写入数据库 一批数据 ？
				end note

			:把服务端返回的支持HomeTime联系人信息写入本地数据库;
				note left 
					1、所有 批次的 网络Response数据，依然 单线程 写入CoreData数据库
					2、每一批 150条 网络Response数据
				end note

			:界面(主线程)读取本地数据库“HomeTime联系人信息”;
				note left 
					使用 CoreData + NSFetchedResultsController，在主线程 观察本地数据库变化
				end note

			:在联系人列表页面显示“HomeTime联系人信息”;
				note left 
					使用 NSFetchedResultsController 把tableView 和 主线程数据 绑定
				end note
		}


		#Hotpink:开始'云端'联系人信息同步(另一个线程在此之前已经启动从服务端拉取所有HomeTime联系人信息);
			note left 
				<b> '云端'联系人信息同步，逻辑与Android一致，并且把Java翻译成ObjectiveC </b>
			end note


		partition 定义`数据类型` {
			:remoteAdded;
			note left
			远程新增数据,而本地没有,当作新数据需要下载到本地
			----
			NSMutableArray<WebDavResource *>
			end note

			:remoteDeleted;
			note left
			远程没有,而本地有的,etag不为空则属于已删除数据,本地需要删除相关数据项 这时本地Ctag小于远程Ctag
			etag是 由`HomeTime联系人信息`转成json之后，排序再md5算出来的，相当于数据项的版本号；
			本地数据库 etag 不为nil，则表示 该数据之前上传过 服务端。
			Ctag现在已经不使用。
			----
			NSMutableArray<HTmContactEntity *>
			end note

			:remoteUpdated;
			note left
			远程和本地都有此数据, 并且etag不同,sync_status不为2修改,Ctag本地小于远程,则下载修改本地数据
			----
			NSMutableArray<WebDavResource *>
			end note


			:localDeleted;
			note left
			远程和本地都有此数据, 本地sync_status为3删除,etag不为空,则为本地删除数据,需要上传将服务器数据删除
			----
			NSMutableArray<WebDavResource *>
			end note

			:localUpdated;
			note left
			远程和本地都有此数据,但etag不同,sync_status为2修改,则是本地新修改数据需要上传（我们认为本地修改的数据为最高优先级，不比较Ctag作为依据）
			----
			NSMutableArray<WebDavResource *>
			end note	
		}

		partition 定义`本地数据同步状态` {
			:deleted;
				note left
				此条数据 在本地数据库 已经被删除(标记删除)。
				此条数据 在从服务端删除成功之后，才会在 本地数据库真正删除。
				end note

			:modified;
				note left
				此条数据 在本地数据库 已经被修改。
				end note

			:added;
				note left
				此条数据 是本地数据库 新增。
				end note

			:normal;
				note left
				此条数据 在本地数据库 常态(默认值，为0)。
				本地数据库的此条数据 与 服务端数据 完成同步之后，
				本地数据库的此条数据同步状态，
				将会由`其他状态`变成[normal]，即常态(0)。
				end note
		}


		fork
		#AAAAAA: 此线程等待另一个线程的信号量 dispatch_semaphore_t;
		end fork


		if (服务端 有 联系人信息?) then (有)

			partition 服务端所有联系人信息 {

				while (遍历 从服务端拉取所有联系人信息)
					note left
						若无特殊说明，`联系人信息` 
						都指 `HomeTime联系人信息`。

						begin to get
				 		 ｀local deleted｀
				 		 ｀local updated｀
						or
				 		 ｀remote updated｀
						resources;
					end note

				if (根据 远程数据的sourceID[主键]，从本地数据库 查找 该sourceID[主键] 数据，有没有?) then (有)
					if (本地数据库 该sourceID的数据，etag为nil?) then (本地数据etag为nil) 

					else (本地数据etag不为nil)
						:根据当前'本地数据'重新生成最新etag，防止客户端生成错误的etag 或未更新etag;
							note right
								本地数据库 etag 不为nil，则表示 该数据之前上传过(但不一定上传成功) 服务端。
								etag是把本地数据 上传到服务端 之前，
								在本地根据此条数据的字段，生成的‘数据版本号标识’。
							end note
					endif


					if (远程数据 etag为nil ？) then (yes)
						:数据错误？;
							note right
								按道理来说，远程数据 etag不会为nil，
								因为: etag 不为nil，则表示 该数据之前上传过(但不一定上传成功) 服务端。
								etag是把本地数据 上传到服务端 之前，
								在本地根据此条数据的字段，生成的‘数据版本号标识’。
							end note

					else (no)

						if (远程数据etag 和 本地数据etag 相等 ？) then (yes)
							if (本地数据 同步状态： deleted) then (yes)
								:本地已经删除 该sourceID的数据，把远程该sourceID数据 进行删除;
								:localDeleted.add(res);

							else if (本地数据 同步状态： modified || added) then (yes)
								:逻辑 不会走到这里;

								detach

							else if (本地数据 同步状态： normal) then (yes)
								:逻辑 会走到这里，do nothing here;

							endif

						else (no)

							if (本地数据 etag为nil) then (yes)
								:本地数据 etag为nil，表示'数据错误'，我们下载远端数据，并更新到 本地数据库;
								:remoteUpdated.add(res);
									note right
										注意这里，逻辑严谨？
									end note

							else (no)
								if (本地数据 同步状态： deleted) then (yes)
									:本地已经删除 该sourceID的数据，把远程该sourceID数据 进行删除;
									:localDeleted.add(res);

								else if (本地数据 同步状态： modified) then (yes)
									:本地数据 已经修改 该sourceID的数据，我们 需要更新 远端数据库;
									:localUpdated.add(res);
										note right
										特别注意：此条数据 在本地数据库的状态 从added变成modified的情况，
										远程和本地都有此数据,但etag不同,sync_status为2修改,
										则是本地新修改数据需要上传
										（我们认为本地修改的数据为最高优先级，不比较Ctag作为依据）	
										end note

								else if (本地数据 同步状态： added) then (yes)
									:逻辑 不会走到这里;

									detach

								else if (本地数据 同步状态： normal) then (yes)

									if (同一个帐号只能登入一个设备的HomeTime iPhone端 ？) then (yes)
										:逻辑 不会走到这里;
											note right
												说明，目前产品需求：单帐号单点登入
											end note

										detach

									else (no --- 说明，目前产品需求：单帐号单点登入)

										:远端数据库 已经修改 该sourceID的数据，我们 需要更新 本地数据库;
										:remoteUpdated.add(res);
									endif

								endif
							endif

						endif

					endif


				else (没有)
					:本地 没有 该sourceID的数据，说明是远程新增数据;
					:remoteAdded.add(res);

					:在 本地数据库中，写入 远程新增数据;
						note left
							注意 此处 是三个数据源的交互：远程数据库、本地数据库、iPhone的系统通讯录数据库。
							注意 标记此条数据，是远程新增数据；
							因为 远程新增数据(HomeTime联系人) 在界面上“联系人详情页面”的导航条右边下拉菜单，
							需要 区分：‘编辑联系人’、‘新增联系人’，
							而此时 `远程新增数据` 去iPhone的系统通讯录中查找，
							是无法找到 对应联系人，所以此时 菜单 `编辑联系人` 变成 `新增联系人`
							 (意思为 远程新增数据 添加到 iPhone的系统通讯录)，
							并且使用 `远端sourceID` 把 远端数据 写入 本地数据库。
						end note

				endif

				endwhile
			}

		else (没有)

			:本地数据库所有HomeTime联系人数据[首次]上传到服务端;
			note left
				for (ContactNumerInfo info : mAllLocalList) {
                    // if (info.getSync_status() < 3 && 
                    // (info.getEtag() == null 
                    // || "".equals(info.getEtag()))) {
                    if (info.getSync_status() < 3) {
                        localAdded.add(info);
                    }
                }
                // pushNew(localAdded);
                multiPushNew(localAdded, true);
			end note

		endif


		partition 本地所有联系人信息 {

			while (遍历 本地数据库 联系人数据)
				note left
				begin to get
				 ｀remote deleted｀
				or
				 ｀local added｀
				resources;
				end note

			if (根据 本地数据库的sourceID[主键]，从远程数据 查找 该sourceID[主键] 数据，有没有？) then (有)
				:在之前 `遍历`远程数据时，已经处理过，所以跳过这条数据;

			else (没有)

				if (本地数据 etag为nil) then (etag为nil)
					if (本地数据 同步状态： deleted) then (yes)
						:远程删除，本地也删除了，直接删除本地数据;
						:remoteDeleted.add(contact);
							note right
								逻辑严谨 ？
							end note

					else if (本地数据 同步状态： modified || added || normal) then (yes)
						:本地有 远程没有，本地Etag为空表示没有上传过该数据，需要上传;
							if (本地数据 没有 被添加到 localAdded)
								:localAdded.add(contact);
							endif
					endif

				else (etag不为nil)
					if (本地数据 同步状态： deleted) then (yes)
						:本地已经删除 该sourceID的数据，把远程该sourceID数据 进行删除;
						:remoteDeleted.add(contact);

					else if (本地数据 同步状态： modified) then (yes)
						:本地有 远程没有,etag不为空表示上传过该数据，本地又修改过该数据，我们以本地为最新，上传该数据;
						:localAdded.add(contact);

					else if (本地数据 同步状态： added) then (yes)
						:逻辑 不会走到这里;

						detach

					else if (本地数据 同步状态： normal) then (yes)
						:本地有 远程没有，本地etag不为空表示上传过该数据，本地 没有修改 并且 没有删除;
						:remoteDeleted.add(contact);

					endif

				endif

			endif

			endwhile
		}


		:begin to upload and download resources;
			note right
				特别说明：如果之前已经启动另一个线程下载服务端所有联系人数据，
						那么流程跑到这里时，就不需要再次下载服务端所有联系人数据。
				否则：
				why this, why download ?
				因为：在此之前的步骤，拉取的联系人信息不完整(仅有sourceID、etag)，相当于http的head请求。
				此处 在此 拉取联系人的完整信息。
			end note

		partition pullNew {
			:将服务器新数据拉取到本地 pullNew(remoteAdded, localAdded);
			while (分批 没有完成？)
				if (此批 完成 ？) then (yes)
					:根据sourceID 设置(setEtag:) 此批 本地数据的etag;
					note right
					根据名字和电话号码查询本地是否有该联系人（相等匹配），若有则更新，若无则插入
		            int id = CloudSyncManager.getInstance().getOperator().insertOrUpdate(info);
		            if (id != -1) {
		                logUtils.d("id is not -1, this is update!");
		                mDumpID.add(id);
		                ContactNumerInfo contact;
		                // update data, not upload to server
		                for (int i = 0; i < localAddedList.size(); i++) {
		                    contact = localAddedList.get(i);
		                    if (id == contact.getId()) {
		                        localAddedList.remove(i);
		                    }
		                }
		            }
					end note
				endif 
			endwhile
		}

		partition pullRemoteUpdated {
			:将远程服务器上更新的数据拉取到本地，更新本地数据库 pullRemoteUpdated(remoteUpdated);

			while (分批 没有完成？)
				if (此批 完成 ？) then (yes)
					:设置 此批 本地数据的etag、syncStatus(NORMAL)、其他字段;
					note right
					List<ContactNumerInfo> contacts = result.getResourceInfos();
		            for (ContactNumerInfo info : contacts) {
		                logUtils.d("pull remote update info.toString== " + info.toString());
		                info.setEtag(CloudSyncManager.getInstance().generateEtag(info));
		                info.setSync_status(CloudSyncManager.SYNCSTATUS.NORMAL.value());
		                CloudSyncManager.getInstance().getOperator().updateContactsBySourceId(info);
		                count++;
		            }
					end note
				endif
			endwhile
		}

		partition addDumpliteDelete {
			:把远程dav对象添加到本地删除数据中，删除远程对象 addDumpliteDelete(resources, localDeleted);

			note right 
			mDumpNeedDeleteRemote = new ArrayList<String>();
		    for (int k = 0; k < mDumpID.size(); k++) {
		        for (ContactNumerInfo contact : mAllLocalList) {
		            if (contact.getId() == mDumpID.get(k)) {
		                if (contact.getEtag() != null && !"".equals(contact.getEtag()) && contact.getSync_status() < CloudSyncManager.SYNCSTATUS.DELETED.value()) {
		                    // Etag 不为空，上传过该数据, 本地未删除
		                    mDumpNeedDeleteRemote.add(contact.getSource_id());
		                }
		            }
		        }
		    }
		    int count = 0;
		    for (int i = 0; i < mDumpNeedDeleteRemote.size(); i++) {
		        for (DavResource res : remoteList) {
		            if (res.getName().equals(mDumpNeedDeleteRemote.get(i))) {
		                localDeletes.add(res);
		                count++;
		            }
		        }
		    }
			end note
		}

		partition multiPushNew {
			:将本地新添加的数据上传到服务器 multiPushNew(localAdded, true);
				note right
				？？？？
				更新本地数据库 每条数据的sourceID ？
				本地数据 没有sourceID，则设置sourceID；
				本地数据   有sourceID，则保持不变；
				for (ContactNumerInfo tmpInfo : localAdded) {
		            if (tmpInfo.getEtag() != null && !"".equals(tmpInfo.getEtag())) {
		                tmpInfo.setSource_id(CloudSyncManager.generateSourceId());
		            }
		        }
		        ？？？？
				end note

			while (分批 没有完成？)
				if (此批 完成 ？) then (yes)
					:更新本地数据 etag、syncStatus[normal]、其他字段;
				else if (数据冲突?) then (yes) 
					:遇到冲突，单个上传处理冲突 pushNew(list);
						note right
							info.setSource_id(CloudSyncManager.generateSourceId());
							换一个 sourceID，重新提交
						end note

				else if (出错：ERROR_SQL_UNACCEPTABLE ？) then (yes)
					if (continueFlag) then (yes)
						:multiPushNew(list, false);
						note right
						？？？
						某个sourceId 之前上传过，后来删掉了，再上传该sourceId会出现该错误
						for (ContactNumerInfo info : list) {
                        	info.setSource_id(CloudSyncManager.generateSourceId());
                    	}
                    	？？？
						end note
					else (no)
						:pushNew(list);
							note right
							？？？
							end note
					endif

					note right
					  logUtils.e("multiple push new resource unacceptable");
			            // 某个sourceId 之前上传过，后来删掉了，再上传该sourceId会出现该错误
			            if (continueFlag) {
			                for (ContactNumerInfo info : list) {
			                    info.setSource_id(CloudSyncManager.generateSourceId());
			                }
			                multiPushNew(list, false);
			            } else {
			                // 单条上传
			                pushNew(list);
			            }
					end note
				else 
					:其他错误码处理;
				endif

			endwhile
		}

		partition resolvePushNewConfilict {
			:在客户端解决 上传过程中 数据冲突 resolvePushNewConfilict(mAllLocalList);
			note right
			????
				for (ContactNumerInfo info : mPushNewConflictList) {
		            if (isHaveSameInfo(list, info)) {
		                // 将本地相同数据（姓名电话号码一样）删除 本地数据
		                info.setSource_id(CloudSyncManager.generateSourceId());
		                info.setSync_status(CloudSyncManager.SYNCSTATUS.DELETED.value());
		                CloudSyncManager.getInstance().getOperator().updateContactsById(info.getId(), info);
		                count++;
		                logUtils.i("resolve push new conflict, update local data id = " + info.getId());
		            }else{
		            	？？？？
		            	名字为标准(解决冲突)
		            	如果名字 相同：所有手机号码合并(注意去重)；
		            	如果名字 不同：相当于新增一个人；
		            }
		        }
			????
			end note
		}

		partition multiPushModify {
			:向服务端 批量 提交 本地已经修改的数据 multiPushModify(localUpdated);

			while (分批 没有完成？)
				if (此批 完成 ？) then (yes)
					:更新本地数据 etag、syncStatus[normal]、其他字段;
				else if (数据冲突?) then (yes) 
					:遇到冲突，单个上传处理冲突 pushModify(list);
				else if (出错：ERROR_SQL_UNACCEPTABLE ？) then (yes)
					:TODO;
					note right
					  TODO 
					end note
				else 
					:其他错误码处理;
				endif
			endwhile
		}

		partition multiPushDeleted {
			:向服务端 批量 提交 本地已经删除的数据 multiPushDeleted(localDeleted);

			while (分批 没有完成 ？)
				if (此批 完成 ？) then (yes) 
					note right
					for (DavResource res : results) {
                   		CloudSyncManager.getInstance().getOperator().realDeleteContactBySourceId(res.getName());
                    	count++;
                	}
					end note
				else if (数据冲突？) 
                	:pushDeleted(list);
                	note right
                	conflict, we push delete one by one
                	end note
				endif
			endwhile
		}

		partition deleteLocal {
			:在客户端 删除 在服务端已经删除的数据 deleteLocal(remoteDeleted);
			note right
			for (ContactNumerInfo info : list) {
            	CloudSyncManager.getInstance().getOperator().realDeleteContactBySourceId(info.getSource_id());
            	count++;
        	}
			end note
		}

		partition 完成 {
			:将正在同步数据`标志位`置为false;
			:回调完成block;
		}
	}

else (no)
	:联系人列表不显示HomeTime联系人;
		note left	
			TODO: 显示 从服务端下载的 
				  由 其他设备HomeTimeApp上传过的HomeTime联系人数据
		end note

	:通话记录搜索，无联系人搜索结果;
		note left	
			TODO: 可以搜索到(本地数据库搜索) 从服务端下载的 
				  由 其他设备HomeTimeApp上传过的HomeTime联系人数据
		end note

	:如果 服务端没有数据 或 系统通讯录过滤之后没有HomeTime联系人 ？？;

endif


stop
@enduml