Wikiの一覧ではそろそろまとまりがなくなってきたので、記事一覧を作りました。
現在のアクセス:138115
JavaWorld?の2004年3月号に特集されていたので、Eclipseのプラグイン開発ツールを触ってみました。
Eclipseはこのプラグインの固まりで、すべての機能はプラグインで作成されているみたいです。ようするにEclipseを機能拡張したい場合はこのプラグインという作法に則って作成するわけですね。
まだ全然やり方がわかりません。とりあえずView(パースペクティブ内の一つのタイルのこと)を拡張して、選択しているファイルのファイル名を表示するプラグインを作成しています。
簡単なやり方は
後はすべてデフォルトでOKでよいです。ウィザードが完了すると、単純なプラグイン・プロジェクトの作成完了です。
基本的な構成はできたので、次はプラグインファイル(plugin.xml)の記述です。手順は
<extension point="org.eclipse.ui.views"> <category name="サンプルMyView" <- viewが属するカテゴリ名 id="com.samples.myview"> <- カテゴリのID </category> <view name="シンプルView" <- viewのバーのタイトル category="com.samples.myview" <- viewが属するカテゴリID class="com.samples.myview.SimpleView" <- viewを実装するクラス名 id="com.samples.myview.simpleview"> <- viewのID </view> </extension>で十分です。プロパティViewよりclassを選択すると対応するクラス(ここではcom.samples.myview.SimpleView?)のスケルトンもウィザードが作ってくれます。
ヘルプに リッチ・クライアント・プラットフォーム・アプリケーションのビルド という項目があったので、見てみるとサンプルがEclipseのCVS
:pserver:anonymous@dev.eclipse.org:/home/eclipse
からチェックアウト可能とのこと。パスワードはなしですね。
WEBからアクセスする場合は
http://dev.eclipse.org/viewcvs/index.cgi/
Log4jの初期化のためにlog4j.xmlを読み込むなど、プラグインディレクトリのパスを取得する場面は結構ありますが、その方法です。
String pluginDirectory = Platform .resolve(getDefault().getDescriptor().getInstallURL()).getPath();
で取得できます。 ちなみにLog4jの初期化などはAbstractUIPluginのサブクラス(勝手に作られるヤツ)で
public void startup() throws CoreException { super.startup(); String pluginDirectory = null; try { pluginDirectory = Platform .resolve(getDefault().getDescriptor().getInstallURL()) .getPath(); } catch (IOException e) { e.printStackTrace(); } DOMConfigurator.configure(new File(pluginDirectory, "lib/log4j.xml").toString()); }
などとstartup()をOverrideすればよいでしょうか。
Eclipse3.0から上のやり方は deprecated になりました。2.0で
String pluginDirectory = Platform .resolve(getDefault().getDescriptor().getInstallURL()).getPath();
だったのを3.0では
URL entry = getDefault().getBundle().getEntry("/"); String pluginDirectory = Platform.resolve(entry).getPath();
と書き換えます。
http://www3.vis.ne.jp/~asaki/p_diary/diary.cgi?Date=2004-09-05
プラグインディレクトリにlibディレクトリなどを作成しておいて、plugin.xmlで
<runtime> <library name="hoge.jar"/> <library name="lib/fuga.jar"/> <-外部ライブラリ </runtime>
とすればOKです。
いわゆるEclipseのプロジェクトへの参照を取得する方法です。
IWorkspaceRoot myWorkspaceRoot = ResourcesPlugin.getWorkspace().getRoot(); IProject project = myWorkspaceRoot.getProject([プロジェクト名の文字列]);
IWorkbench workbench = PlatformUI.getWorkbench(); IWorkbenchWindow window = workbench.getActiveWorkbenchWindow(); Shell shell = window.getShell(); MessageDialog.openInformation(shell, "タイトル","メッセージ");
が定番でしょう。windowオブジェクトはメソッドを記述するクラスによってはフィールドから得られたりしますが。。
IWorkbenchPage page = workbench.getActiveWorkbenchWindow().getActivePage(); IViewReference[] references = page.getViewReferences(); for (int i = 0; i < references.length; i++) { IViewPart view = references[i].getView(false); <- Viewへの参照が取得できました MessageDialog.openInformation(window.getShell(), "ViewのtoString()", view.toString()); }
IWorkbench workbench = PlatformUI.getWorkbench(); IWorkbenchPage workbenchPage = workbench .getActiveWorkbenchWindow().getActivePage(); //IWorkbenchPage workbenchPage = editor.getSite().getPage(); try { HogeView view = (HogeView) workbenchPage.showView("HogeViewのID"); } catch (PartInitException e) { }
Eclipse3.0から(だと思う)同じウィンドウを複数開くことができるようです。
IWorkbench workbench = PlatformUI.getWorkbench(); IWorkbenchPage workbenchPage = workbench .getActiveWorkbenchWindow().getActivePage(); try { HogeView view = (HogeView) workbenchPage .showView("HogeViewのID", "HogeViewの別のID(Uniqueならよい?)", IWorkbenchPage.VIEW_ACTIVATE); } catch (PartInitException e) { }
http://d.hatena.ne.jp/muimy/20040804 から情報をいただきました。
トラブル(↓メモ書き状態)
パッケージ化するとインスタンスを生成できない。 私も同じトラブルに遭遇しました。
プラグインをパッケージングすると、何故かエラーになってしまうというもの。ビューを開こうとすると
インスタンスを生成できませんでした。
と言われてしまうんだけど、エラーを調べようにもどこにエラーが表示されているのかも分からないので困っていました。
そこでネットを探していたところ、同じような内容の投稿が。とりあえずこれを見て、プラグインのログは
というところまで分かりました。感謝!!
そのエラーログを見ると、xml関連のライブラリがないと。どうもプラグインをパッケージした場合と、ランタイムワークベンチで稼動しているVMのバージョンの違いが原因でした。*1 plugin.xmlに、
<library name="lib/xercesImpl.jar"/> <library name="lib/xml-apis.jar"/>
を追加して、ようやく動きました。疲れた...。。。
http://www-6.ibm.com/jp/developerworks/opensource/040604/j_os-ecspy1.html
// IExtensionからそれが宣言されているプラグインをIPluginDescriptorとして取り出す。 IPluginDescriptor descriptor = extension.getDeclaringPluginDescriptor(); // そのプラグイン用のクラスローダを取得。 ClassLoader classLoader = descriptor.getPluginClassLoader(); DOMConfigurator configurator = (DOMConfigurator) classLoader .loadClass("org.apache.log4j.xml.DOMConfigurator") .newInstance();
String namespace = extension.getNamespace(); Bundle bundleOfExtension = Platform.getBundle(namespace); DOMConfigurator configurator = (DOMConfigurator) bundleOfExtension .loadClass("org.apache.log4j.xml.DOMConfigurator") .newInstance();
どうも、↑こうやってもDOMConfiguratorはlog4j.jarの入ってるプラグインで実行されているっぽい。。EclipseCon2005 TUTORIALS 26 Developing for the Rich Client Platform のFrequent problems with third party libraries によれば
Thread currentThread = Thread.currentThread(); ClassLoader oldClassLoader = currentThread.getContextClassLoader(); try { currentThread.setContextClassLoader(plugin.getClass().getClassLoader()); // 普通に処理を書く } finally { currentThread.setContextClassLoader(oldClassLoader); }
が正解っぽい??すいません。時間切れ。。
○○Pluginなど、プラグインクラスにはそのプラグインでやりたいビジネスロジックや、ログ出力などのロジックを記述します。ログ出力に関するメソッドはだいたい以下のようなメソッドを定義しておけばよいでしょう。
public static void log(String message, Exception e) { IStatus status = new Status(IStatus.ERROR, getPluginId(), IStatus.ERROR, message, e); getDefault().getLog().log(status); } public static void log(String message) { log(message, null); } public static void log(Exception e) { StringWriter stringWriter = new StringWriter(); e.printStackTrace(new PrintWriter(stringWriter)); String message = stringWriter.getBuffer().toString(); log(message, e); } public static String getPluginId() { return getDefault().getBundle().getSymbolicName(); }
Eclipse自体のTIPSですが、メモメモ。
Eclipseはハードコーディングされた文字列を外部ファイル(*.properties)に外出しするリファクタリングをすることができます。で、それをやるとStringの一覧のダイアログが出るんですけど、なんかわかりにくかったんでまとめておきます。各チェックの意味は以下の通り。
チェック | Externalize | 外部化して、//$NON-NLS-1$ をつける |
× | Ignore | 以後無視するよう、//$NON-NLS-1$ をつける |
×' | Internalize | //$NON-NLS-1$ をはずすもしくはなにもしない |
Eclipse付属のマニュアルは以下のようになっています。
それぞれの依存性は、<import> エレメントを使用して指定されます。これには以下の属性が含まれています。
とくに
A -> B -> CプラグインBで、プラグインCのexportをtrueにしておけば、AはCをimportしなくてもつかえるってこと?
Log4jのライブラリをさまざまなプラグインで使用するので、ひとつのプラグインにしているんだけど、そのプラグインがいっつも不要なプラグインで出てきちゃう。。jarを共有するためだけの場合は、使ってることが検出できないのかな。
ワークスペース内のプラグインプロジェクトを、全て「クラスパスの更新」をやったら、検出できるようになった。ふしぎだ。
1番目と最後の違いは、1番目はフィーチャー自体のバージョンに他のバージョンをあわせるので、全てのプラグインのバージョンは同じになります。最後のはxmlファイルに書いてあるそれぞれプラグインのバージョンをそれぞれのプラグインに適用する、という違いですね。
if (productName == null) { message = "Exit application?"; } else { // プレースホルダが使えるの? message = NLS.bind("Exit {0}?", productName); }
という感じで使える。。
たとえばnu.mine.kino.pluginというプラグインでコンテキストヘルプ(F1のイベントを拾ってヘルプを表示する機能)を使用するには以下のようにします。
viewer.addHelpListener(new HelpListener() { public void helpRequested(HelpEvent e) { String contextId = "nu.mine.kino.plugin.workbench_window_context"; nu.mine.kino.pluginはプラグインID workbench_window_contextは後述のcontext.xml内のキー値。 WorkbenchHelp.displayHelp(contextId); } });
実際のコンテキストに表示される内容は拡張ポイントorg.eclipse.help.contextsで指定します。 nu.mine.kino.plugin#plugin.xmlに
<extension point="org.eclipse.help.contexts"> <contexts file="context.xml"> </contexts> </extension>
とします。
で、context.xmlは以下のよう:
<?xml version="1.0" encoding="UTF-8"?> <?NLS TYPE="org.eclipse.help.contexts"?> <contexts> <context id="workbench_window_context"> <-さっきのキー値。 <description>ヘルプです。</description> <topic label="てすとワークベンチ" href="concepts/concepts-2.htm"/> <topic label="てすとパースペクティブ" href="concepts/concepts-4.htm"/> <topic label="てすとワークベンチの管理" href="tasks/tasks-1.htm"/> </context> </contexts>
こうするとviewer上でF1を押したとき、ヘルプが表示されます。
viewer.addHelpListener(new HelpListener() { public void helpRequested(HelpEvent e) { String contextId = "nu.mine.kino.doc.workbench_window_context"; // nu.mine.kino.doc はこのソースのプラグインとは別のプラグインとします WorkbenchHelp.displayHelp(contextId); } });
nu.mine.kino.doc#plugin.xmlには以下の内容を記述しておきます。
<extension point="org.eclipse.help.contexts"> <contexts file="context.xml" > </contexts> </extension>
context.xmlの書き方は同じでかまいません。
いろいろ処理を調べてみたところ、どうも指定したcontextIdの最後のドットを見てパースし、手前までをプラグインID、その後をキー値としてるみたいだ*2。
ところで、Eclipse3.1から、
WorkbenchHelp.displayHelp(contextId);
はdeprecatedとなったため、3.1以後は
PlatformUI.getWorkbench().getHelpSystem() .displayHelp(contextId);
とするほうがよいようです。
リレーショナル・データベース・サーバーをEclipseに埋め込む みてて知ったTIPS
window 変数をIWorkbenchWindow? の インスタンスとしたとき
((ApplicationWindow)window).setStatus("HSQLDB Server already running.");
で、ステータスバーに文字列を表示することが出来る
まずはパースペクティブのレジストリへのアクセス方法です。パースペクティブはorg.eclipse.ui.IPerspectiveRegistry? というレジストリで管理されています。
IPerspectiveRegistry pRegistry = PlatformUI.getWorkbench().getPerspectiveRegistry();
でレジストリへの参照を取得できます。
続いてパースペクティブ自体にアクセスします。パースペクティブは、何となくわかってきましたがIPerspectiveDescriptor?と一対一対応します。IPerspectiveDescriptor?には
public String getDescription(); public String getId(); public ImageDescriptor getImageDescriptor(); public String getLabel();
などのメソッドがあります。
IPerspectiveDescriptor?への参照は以下のように取得できます。
IPerspectiveDescriptor[] perspectives = pRegistry.getPerspectives();
IPerspectiveDescriptor descriptor = pRegistry.findPerspectiveWithId("plugin.xmlのパースペクティブID");
パースペクティブをセットするメソッドがIWorkbenchWindow?とかIWorkbenchPage?にあるはず、、と思って探したら、ありました。
PlatformUI.getWorkbench().getActiveWorkbenchWindow().getActivePage(). setPerspective(descriptor);<-descriptorはIPerspectiveDescriptor でレジストリから取って来る
なげぇよ、長すぎるよ。あもちろんwindowとか取れる場合はPlatformUIとかからやらなくていいですけどね。めんどくさくなると、すぐPlatformUIよんでしまう。。
Eclipse3.1から導入された、ウィジェット上にリンクを表示するLinkクラスの使い方です。
コード
Link link = new Link(container, SWT.NONE); link.setText("<a>リンク</a>, <a>portable</a> <a href=\"native\">operating systems</a> on which it is implemented."); link.addListener(SWT.Selection, new Listener() { public void handleEvent(Event event) { System.out.println("Selection: " + event.text); ↑event.textで、href属性があればその中の文字列(上ならnative)、 href属性がなければ<a>○○</a>の中に囲まれた「○○」が取得できる } });
このようにして、SWT.Selectionのイベントを見て処理をすればよいようです。クリックしたらウィザードを起動するとか、ベタにブラウザを起動するとか、なんでもできますね。
Eclipseには、ISelectionProviderという、「選択されているオブジェクトを外部に公開するクラス」を、Viewごとに設定することができます。このオブジェクトはViewごとに存在するので、各Viewのこのインスタンスを取得できれば、選択されているオブジェクトを
getSite().getSelectionProvider().getSelection();
と取得できます。
さらにもっと便利なメソッドがありました。
ISelection selection = page.getSelection([viewid]);
で一発で取得できます。pageはIWorkbenchPage?のインスタンスです。これは便利!!
Eclipseプラグイン開発の練習として、Google Web APIsを使ったプラグインを作ってみました。要件としては
といった感じですかね。
Eclipse自体を見ていると、プラグイン開発はGUI部分とビジネスロジックのCore部分を分けて作るのが基本みたいです。なので今回作成するプラグイン構成は
な感じにしました。
更新サイトよりインストール可能です。 URLはこちら。
Eclipse3.1で開発しているので、今のところ3.1でしか稼動しないかも?
基本的にCPLとか、適当にやっちゃいたいところですが、Google Web APIsが個人・非商用のみOKなのでそれに準じる、とするべきなんですかねえ。Google Web APIsのライセンスについてはTerms and Conditions for Google Web API Serviceをご確認ください*4。
結局、ライセンスはとりあえず無難にGPLにすることにしました。
現在のアクセス:148572
この記事は
現在のアクセス:140188