annotate final_main/chapter2/chapter2.tex @ 10:5ddb3e41e515

remove .DS_Store
author ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
date Wed, 12 Feb 2020 19:40:35 +0900
parents a37b7bd13be9
children b8149a449b7d
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
2
97d58fdc8185 add copies final_main
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents:
diff changeset
1 %\input{/Users/e155753/.tex/setup}
97d58fdc8185 add copies final_main
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents:
diff changeset
2
97d58fdc8185 add copies final_main
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents:
diff changeset
3 %%文書開始****************************
97d58fdc8185 add copies final_main
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents:
diff changeset
4 \begin{document}
97d58fdc8185 add copies final_main
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents:
diff changeset
5 %%**************************************
9
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 8
diff changeset
6 \chapter{リモートエディタ}
10
5ddb3e41e515 remove .DS_Store
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 9
diff changeset
7 リモートエディタとは他のマシン上に存在するファイルのバッファを別デバイスから開いて編集, 保存することができる機能である.
5ddb3e41e515 remove .DS_Store
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 9
diff changeset
8 加えてこのリモートエディタを複数人が同時に同じファイルを編集し, その上変更がリアルタイムに反映されるように設計する.
9
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 8
diff changeset
9 この章ではリモートエディタの実装の上で踏んだプロセスや, 開発の上で問題となる点と解決策について説明する。
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 8
diff changeset
10
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 8
diff changeset
11 \section{document listenerによる編集オフセット番号の読み取り}
10
5ddb3e41e515 remove .DS_Store
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 9
diff changeset
12 エディタ同士の基本通信環境の構成のため, Chrisitie と同様のjava 言語で作成したエディタのインスタンスを使い, 異なるマシン同士の同期の実現を目指した.
5ddb3e41e515 remove .DS_Store
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 9
diff changeset
13 自作エディタは java. swingの機能で構成されており, コードをオフセット番号で取り扱っている.
5ddb3e41e515 remove .DS_Store
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 9
diff changeset
14
5ddb3e41e515 remove .DS_Store
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 9
diff changeset
15 追記または削除されたオフセット位置とその内容の取得はDocumentListenrを使用した.
5ddb3e41e515 remove .DS_Store
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 9
diff changeset
16 DocumentListenerのクラスはswingで実装したエディタ部分の入力と削除を検知し, 動作するメソッドであり, DocumentEvent内に入力されたオフセットとその長さや文字列が入力されるため, それをChrisitie側で検知し処理を行った.
5ddb3e41e515 remove .DS_Store
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 9
diff changeset
17 insertUpdateメソッドではバッファに入力が行われた際に自動的に実行され, removeUpdateメソッドは同様にバッファ内の文字のいずれかが削除が行われた際に実行される.
5ddb3e41e515 remove .DS_Store
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 9
diff changeset
18 他ノードから送信されてきた命令によるバッファの変更によっても実行され, 意図しないループが発生したため, 受信した命令では実行されないように記述をおこなった.
5ddb3e41e515 remove .DS_Store
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 9
diff changeset
19 コード\ref{code:DocumentListener}はinsertUpdate, removeUpdateの記述部分である.
9
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 8
diff changeset
20
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 8
diff changeset
21 \lstinputlisting[caption=DocumentListenerのコード部分, label=code:DocumentListener]{./src/DocumentListener.java}
2
97d58fdc8185 add copies final_main
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents:
diff changeset
22
97d58fdc8185 add copies final_main
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents:
diff changeset
23
9
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 8
diff changeset
24 \section{Command パターンによる命令オブジェクトの作成}
10
5ddb3e41e515 remove .DS_Store
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 9
diff changeset
25 リモートエディタを実装する上において, 各エディタは自身に起きたバッファの変更を他ノードに送信する必要がある.
5ddb3e41e515 remove .DS_Store
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 9
diff changeset
26 この変更の送り合いをCommand パターンとして実装した.
5ddb3e41e515 remove .DS_Store
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 9
diff changeset
27 Command パターンとは, 命令を一つのオブジェクトとして表現する方法である.
5ddb3e41e515 remove .DS_Store
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 9
diff changeset
28 コマンドパターンの利点として,
5ddb3e41e515 remove .DS_Store
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 9
diff changeset
29
9
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 8
diff changeset
30 \begin{itemize}
10
5ddb3e41e515 remove .DS_Store
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 9
diff changeset
31 \item インスタンスを利用して命令を作成するため, 後述のChristieのGearの概念と相性が良い.
9
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 8
diff changeset
32 \item 命令に必要な内容をまとめて送信するため, 相違の発生を防ぐことができる.
10
5ddb3e41e515 remove .DS_Store
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 9
diff changeset
33 \item 命令の管理が行いやすい, 行列に並ばせ命令の順番を管理したり, 命令の際, 実行, 取り消しが容易になる.
9
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 8
diff changeset
34 \end{itemize}
10
5ddb3e41e515 remove .DS_Store
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 9
diff changeset
35
5ddb3e41e515 remove .DS_Store
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 9
diff changeset
36 といった点が挙げられる.
5ddb3e41e515 remove .DS_Store
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 9
diff changeset
37 ソースコード:\ref{code:Command}は書き込み, 送信を行う際の命令をクラスとして作成したものである.
5ddb3e41e515 remove .DS_Store
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 9
diff changeset
38 このクラスのインスタンスを命令オブジェクトとして送信し合う.
9
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 8
diff changeset
39
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 8
diff changeset
40 \lstinputlisting[caption=Commandパターンとして実装した命令, label=code:Command]{./src/Command.java}
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 8
diff changeset
41
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 8
diff changeset
42 \section{命令オブジェクトを実装する際に起きた問題}
10
5ddb3e41e515 remove .DS_Store
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 9
diff changeset
43 インスタンス化した命令を他ノードに送信する際にエラーが発生し, 送信に失敗してしまうという問題が発生した.
5ddb3e41e515 remove .DS_Store
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 9
diff changeset
44 クラスの送信の際のシリアライズはmsgpackクラスを利用している.
5ddb3e41e515 remove .DS_Store
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 9
diff changeset
45 msgpackクラスは,シリアライズしたいクラスにMessage アノテーションをつけることにより, シリアライズ化を行う.
5ddb3e41e515 remove .DS_Store
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 9
diff changeset
46 原因を調査した結果, 以下の原因が見つかった.
5ddb3e41e515 remove .DS_Store
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 9
diff changeset
47
2
97d58fdc8185 add copies final_main
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents:
diff changeset
48 \begin{itemize}
9
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 8
diff changeset
49 \item Christieのjavaバージョンは11を使用していたが, msgpackバージョン0.6.12はjava11に対して対応していなかった.
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 8
diff changeset
50 \item msgpackの最新版0.8.20はシリアライズ機能が含まれなくなった.
2
97d58fdc8185 add copies final_main
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents:
diff changeset
51 \end{itemize}
97d58fdc8185 add copies final_main
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents:
diff changeset
52
9
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 8
diff changeset
53 以上の原因に対処するために以下のことを行った.
4
c1732eac57f6 add some section
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 2
diff changeset
54
9
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 8
diff changeset
55 \begin{itemize}
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 8
diff changeset
56 \item Christieのjavaバージョンを8まで下げ, msgpackバージョン0.6.12を動作できるようにした.
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 8
diff changeset
57 \item シリアライズする命令クラスに対し, フィールドをpublic にした.
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 8
diff changeset
58 \item javassistのバージョンを最新版へ変更した.
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 8
diff changeset
59 \end{itemize}
2
97d58fdc8185 add copies final_main
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents:
diff changeset
60
10
5ddb3e41e515 remove .DS_Store
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 9
diff changeset
61 javaのバージョンを下げたのは応急的な処置となってしまったが, これらの処置により問題なくCommandパターンでの命令実装を行うことができた.
5ddb3e41e515 remove .DS_Store
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 9
diff changeset
62 javaのバージョンに左右されずリモートエディタを実装するには, シリアライズの機能について他のパッケージを使うか, 自信で作成する必要が生まれた。
4
c1732eac57f6 add some section
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 2
diff changeset
63
c1732eac57f6 add some section
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 2
diff changeset
64
9
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 8
diff changeset
65 \section{編集位置の相違}
10
5ddb3e41e515 remove .DS_Store
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 9
diff changeset
66 セッション中のエディタ間の通信で生じうる, 編集結果の相違について説明する.
5ddb3e41e515 remove .DS_Store
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 9
diff changeset
67 エディタ同士のコマンドの送信はそれぞれが独立して行うため, 編集対象の領域にエディタ間で相違が生じる場合がある.
5ddb3e41e515 remove .DS_Store
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 9
diff changeset
68
5ddb3e41e515 remove .DS_Store
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 9
diff changeset
69 例としてエディタが一対一の接続となっている時に発生しうる相違を図\ref{fig:difference} を使用して解説する.
5ddb3e41e515 remove .DS_Store
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 9
diff changeset
70 編集対象は各オフセット番号に同じ値の数字が入っているものとする.
5ddb3e41e515 remove .DS_Store
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 9
diff changeset
71 EditorA ではオフセット番号 3 の 3 という 要素を削除 (テキストエディタ上のため削除されたオフセットにはその後ろの要素が繰り上げられる.), EditorB では オフセット番号 2 に A という要素を挿入するという編集をしたとする.
5ddb3e41e515 remove .DS_Store
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 9
diff changeset
72 この編集を共通プロトコルとして互いに送信しあった際, 本来編集する予定だったオフセットの中身が異なってしまい編集結果に違いが生じてしまう.
5ddb3e41e515 remove .DS_Store
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 9
diff changeset
73 これらの問題を解決することのできるエディタ同士の通信手法を作成しなければならない。
2
97d58fdc8185 add copies final_main
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents:
diff changeset
74
97d58fdc8185 add copies final_main
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents:
diff changeset
75 \begin{figure}[H]
97d58fdc8185 add copies final_main
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents:
diff changeset
76 \centering
97d58fdc8185 add copies final_main
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents:
diff changeset
77 \fbox{
9
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 8
diff changeset
78 \includegraphics[scale=0.6]{./images/difference_offset.pdf}
2
97d58fdc8185 add copies final_main
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents:
diff changeset
79 }
9
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 8
diff changeset
80 \caption{通信のすれ違いによる編集位置の相違}
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 8
diff changeset
81 \label{fig:difference}
2
97d58fdc8185 add copies final_main
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents:
diff changeset
82 \end{figure}
97d58fdc8185 add copies final_main
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents:
diff changeset
83
9
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 8
diff changeset
84 \section{編集位置の相違解消方法}
10
5ddb3e41e515 remove .DS_Store
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 9
diff changeset
85 編集するオフセットに相違が発生する条件として, サーバーとノードがお互いにコマンドを送り合った際, その命令コマンドが相手に到着する前に相手が自身のバッファに変更を加えてしまった場合に起きる.
5ddb3e41e515 remove .DS_Store
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 9
diff changeset
86 したがって, 相違の解消に必要なことは
5ddb3e41e515 remove .DS_Store
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 9
diff changeset
87
9
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 8
diff changeset
88 \begin{itemize}
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 8
diff changeset
89 \item サーバーとノード間のコマンド送信のすれ違いが発生したということを検知する方法
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 8
diff changeset
90 \item すれ違いが発生した際に編集したオフセットのズレを修正する方法
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 8
diff changeset
91 \end{itemize}
10
5ddb3e41e515 remove .DS_Store
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 9
diff changeset
92
9
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 8
diff changeset
93 が挙げられる.
2
97d58fdc8185 add copies final_main
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents:
diff changeset
94
97d58fdc8185 add copies final_main
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents:
diff changeset
95
97d58fdc8185 add copies final_main
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents:
diff changeset
96
97d58fdc8185 add copies final_main
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents:
diff changeset
97 %%文書終了****************************
9
ichikitakahiro <e165713@ie.u-ryukyu.ac.jp>
parents: 8
diff changeset
98 \end{document}