testAnnotationProcessor "..."
と書くと実行されてクラスは作られてテストも想定通り動くが、Android Studio上ではクラスが参照できずにエラーになる。
https://issuetracker.google.com/issues/37121918
関連したgistに回答があった。
gist.github.com
android {
defaultConfig {
android.libraryVariants.all {
def aptOutputDir = new File(buildDir, "generated/source/apt/${it.unitTestVariant.dirName}")
it.unitTestVariant.addJavaSourceFoldersToModel(aptOutputDir)
}
}
}
Annotation Processor のテスト書きたいなと思って書いてた。
[java] モダンな Annocation Processor の開発手順まとめ - tokuhirom's blog
package com.github.hisaichi5518.konohana.processor; import com.google.common.truth.Truth; import com.google.testing.compile.JavaFileObjects; import com.google.testing.compile.JavaSourceSubjectFactory; import org.junit.Test; public class KonohanaProcessorTest { @Test public void test() { Truth.assert_().about(JavaSourceSubjectFactory.javaSource()) .that(JavaFileObjects.forResource("Success.java")) .processedWith(new KonohanaProcessor()) .compilesWithoutError(); } }
コンパイルが通ったらテストが通るというのをやろうとしたら通らない！！！なぜ！！javapoetのTypeName.get() できてない！
java.lang.RuntimeException: java.lang.IllegalArgumentException: part '<any>' is keyword at com.sun.tools.javac.main.Main.compile(Main.java:553) at com.sun.tools.javac.api.JavacTaskImpl.doCall(JavacTaskImpl.java:129) at com.sun.tools.javac.api.JavacTaskImpl.call(JavacTaskImpl.java:138) at com.google.testing.compile.Compiler.compile(Compiler.java:146) at com.google.testing.compile.JavaSourcesSubject$CompilationClause.compilation(JavaSourcesSubject.java:293) at com.google.testing.compile.JavaSourcesSubject$CompilationClause.compilesWithoutError(JavaSourcesSubject.java:267) at com.github.hisaichi5518.konohana.processor.KonohanaProcessorTest.test(KonohanaProcessorTest.java:15) at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method) at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62) at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43) at java.lang.reflect.Method.invoke(Method.java:498) at org.junit.runners.model.FrameworkMethod$1.runReflectiveCall(FrameworkMethod.java:50) at org.junit.internal.runners.model.ReflectiveCallable.run(ReflectiveCallable.java:12) at org.junit.runners.model.FrameworkMethod.invokeExplosively(FrameworkMethod.java:47) at org.junit.internal.runners.statements.InvokeMethod.evaluate(InvokeMethod.java:17) at org.junit.runners.ParentRunner.runLeaf(ParentRunner.java:325) at org.junit.runners.BlockJUnit4ClassRunner.runChild(BlockJUnit4ClassRunner.java:78) at org.junit.runners.BlockJUnit4ClassRunner.runChild(BlockJUnit4ClassRunner.java:57) at org.junit.runners.ParentRunner$3.run(ParentRunner.java:290) at org.junit.runners.ParentRunner$1.schedule(ParentRunner.java:71) at org.junit.runners.ParentRunner.runChildren(ParentRunner.java:288) at org.junit.runners.ParentRunner.access$000(ParentRunner.java:58) at org.junit.runners.ParentRunner$2.evaluate(ParentRunner.java:268) at org.junit.runners.ParentRunner.run(ParentRunner.java:363) at org.junit.runner.JUnitCore.run(JUnitCore.java:137) at com.intellij.junit4.JUnit4IdeaTestRunner.startRunnerWithArgs(JUnit4IdeaTestRunner.java:117) at com.intellij.junit4.JUnit4IdeaTestRunner.startRunnerWithArgs(JUnit4IdeaTestRunner.java:42) at com.intellij.rt.execution.junit.JUnitStarter.prepareStreamsAndStart(JUnitStarter.java:262) at com.intellij.rt.execution.junit.JUnitStarter.main(JUnitStarter.java:84) at sun.reflect.NativeMethodAccessorImpl.invoke0(Native Method) at sun.reflect.NativeMethodAccessorImpl.invoke(NativeMethodAccessorImpl.java:62) at sun.reflect.DelegatingMethodAccessorImpl.invoke(DelegatingMethodAccessorImpl.java:43) at java.lang.reflect.Method.invoke(Method.java:498) at com.intellij.rt.execution.application.AppMain.main(AppMain.java:147) Caused by: java.lang.IllegalArgumentException: part '<any>' is keyword at com.squareup.javapoet.Util.checkArgument(Util.java:64) at com.squareup.javapoet.ClassName.<init>(ClassName.java:49) at com.squareup.javapoet.ClassName.<init>(ClassName.java:43) at com.squareup.javapoet.ClassName.get(ClassName.java:218) at com.squareup.javapoet.TypeName$1.visitDeclared(TypeName.java:268) at com.squareup.javapoet.TypeName$1.visitError(TypeName.java:290) at com.squareup.javapoet.TypeName$1.visitError(TypeName.java:243) at com.sun.tools.javac.code.Type$ErrorType.accept(Type.java:1855) at com.squareup.javapoet.TypeName.get(TypeName.java:243) at com.squareup.javapoet.TypeName.get(TypeName.java:238) at com.github.hisaichi5518.konohana.processor.definition.KeyDefinition.<init>(KeyDefinition.java:35) at com.github.hisaichi5518.konohana.processor.definition.StoreDefinition.lambda$keyDefinitionStream$3(StoreDefinition.java:88) at java.util.stream.ReferencePipeline$3$1.accept(ReferencePipeline.java:193) at java.util.stream.ReferencePipeline$2$1.accept(ReferencePipeline.java:175) at java.util.Iterator.forEachRemaining(Iterator.java:116) at java.util.Spliterators$IteratorSpliterator.forEachRemaining(Spliterators.java:1801) at java.util.stream.AbstractPipeline.copyInto(AbstractPipeline.java:481) at java.util.stream.AbstractPipeline.wrapAndCopyInto(AbstractPipeline.java:471) at java.util.stream.ForEachOps$ForEachOp.evaluateSequential(ForEachOps.java:151) at java.util.stream.ForEachOps$ForEachOp$OfRef.evaluateSequential(ForEachOps.java:174) at java.util.stream.AbstractPipeline.evaluate(AbstractPipeline.java:234) at java.util.stream.ReferencePipeline.forEach(ReferencePipeline.java:418) at com.github.hisaichi5518.konohana.processor.builder.StoreMethods.build(StoreMethods.java:23) at com.github.hisaichi5518.konohana.processor.writer.StoreWriter.buildTypeSpec(StoreWriter.java:41) at com.github.hisaichi5518.konohana.processor.writer.StoreWriter.write(StoreWriter.java:73) at com.github.hisaichi5518.konohana.processor.writer.StoreWriter.write(StoreWriter.java:30) at java.util.stream.ForEachOps$ForEachOp$OfRef.accept(ForEachOps.java:184) at java.util.stream.ReferencePipeline$3$1.accept(ReferencePipeline.java:193) at java.util.stream.ReferencePipeline$2$1.accept(ReferencePipeline.java:175) at java.util.Iterator.forEachRemaining(Iterator.java:116) at java.util.Spliterators$IteratorSpliterator.forEachRemaining(Spliterators.java:1801) at java.util.stream.AbstractPipeline.copyInto(AbstractPipeline.java:481) at java.util.stream.AbstractPipeline.wrapAndCopyInto(AbstractPipeline.java:471) at java.util.stream.ForEachOps$ForEachOp.evaluateSequential(ForEachOps.java:151) at java.util.stream.ForEachOps$ForEachOp$OfRef.evaluateSequential(ForEachOps.java:174) at java.util.stream.AbstractPipeline.evaluate(AbstractPipeline.java:234) at java.util.stream.ReferencePipeline.forEach(ReferencePipeline.java:418) at com.github.hisaichi5518.konohana.processor.KonohanaProcessor.process(KonohanaProcessor.java:31) at com.sun.tools.javac.processing.JavacProcessingEnvironment.callProcessor(JavacProcessingEnvironment.java:794) at com.sun.tools.javac.processing.JavacProcessingEnvironment.discoverAndRunProcs(JavacProcessingEnvironment.java:705) at com.sun.tools.javac.processing.JavacProcessingEnvironment.access$1800(JavacProcessingEnvironment.java:91) at com.sun.tools.javac.processing.JavacProcessingEnvironment$Round.run(JavacProcessingEnvironment.java:1035) at com.sun.tools.javac.processing.JavacProcessingEnvironment.doProcessing(JavacProcessingEnvironment.java:1176) at com.sun.tools.javac.main.JavaCompiler.processAnnotations(JavaCompiler.java:1170) at com.sun.tools.javac.main.JavaCompiler.compile(JavaCompiler.java:856) at com.sun.tools.javac.main.Main.compile(Main.java:523) ... 33 more
コンパイル対象のファイルを見てたら、java.util.Listがimportされてなかった…マジか………。追加したら無事なおった。
追記:
gfxさんにテストの内容について教えてもらった
正常系はlibrary側でやるのがよさそう
annotation prosessorのテスト、コンパイルエラーにしたいケースでしかやってないです。というか、機能のテストはできないからテストの意味がない…。
— FUJI Goro (@__gfx__) 2017年9月21日
正常系は、生成したコードの機能をテストするのがいいんじゃないですかね。
— FUJI Goro (@__gfx__) 2017年9月21日
作る度に毎度似たようなことをしていてめんどくさい。しかも忘れていたりするのでテンプレート化したいんですが、Android Studioを更新するときにはテンプレートを消さないといけないとかあるらしくてそれはそれでだるいので、とりあえず将来の自分のためにメモとして残しておく。
ここでは、Konohanaという名前のライブラリを作ろうとしています。 名前の由来は、此花区です。かわいい。
全部のログはここにあります。
まずは、サンプルアプリを作ります。
File -> New Project を選択
com.github.hisaichi5518.konohana.exampleに変更するKonohana にするそのあとは自分がmin sdkなどを指定してFinishを押す。 ビルド出来るようになるので、とりあえずビルドして安心感を得る。
プロジェクト生成が終われば、Gitをアレしてソレする。
git initcurl https://www.gitignore.io/api/vim%2Candroid%2Candroidstudio > .gitignoregit add .git commit -m "first commit"gitignoreを自分で頑張るのは不毛なので gitignore.io に任せる。僕が利用するVim, Android, Android Studio を指定してある。 Githubにリポジトリ作るとかは良きタイミングで。
File -> New Module -> Android Library を選択
Konohanalibrarycom.github.hisaichi5518.konohana
Android libraryの中にannotationを入れてもいいような気がしますが、後述するProcessor library(Java library)がAndroid libraryに依存するのが許せなかったので分けます。
File -> New Module -> Java Library を選択
annotationcom.github.hisaichi5518.konohana.annotationKeyannotations としているライブラリがいくつかありましたが、他は単数形でこれだけ複数形にするのが気になったのでやめました。なにか複数形にするべき理由があるのかもしれない。
File -> New Module -> Java Library を選択
processorcom.github.hisaichi5518.konohana.processorKonohanaProcessor
processorのみJava8を指定する。
JavaVersion.VERSION_1_8 を指定する以下のように変更し、git commit する。
以下を追加する
compile project(':annotation')以下を追加する
annotationProcessor project(':processor')compile project(':library')以下を追加する
compile project(':annotation')Android Studio 3.0だと不要だと思う。 以下のコミットのように追加する。
以下のコミットのように追加していく。
また様々な箇所でバージョンを指定する必要があり、揃える必要があるライブラリ（例えばサポートライブラリ）は、バージョンを変数にいれる。
ライブラリは、最新版を利用したほうがいいので、以下のURLを確認
最後に library/build.gradleにある appcompat-v7 は不要であることもあるので、不要なら消す。
KonohanaProcessor を変更していく。
自動生成されるのはclassなのでAnnotationにする。 あとexampleで利用するコード書いておく。
@Target(ElementType.FIELD) public @interface Key { }
public class MainActivity extends AppCompatActivity { @Key String name; @Override protected void onCreate(Bundle savedInstanceState) { super.onCreate(savedInstanceState); setContentView(R.layout.activity_main); } }
Build -> Rebuild Project
なんかもっとスマートなやり方があったら知りたい。 github.com
annotation processor 毎度忘れる。
Observable<String>を作りたい場合はこうする ParameterizedTypeName.get(RxJavaTypes.Observable, JavaTypes.String)社内向けに書いたけど転載。
開発をしていると判断していくことが数多くあります。世界中で公開されているライブラリの中から1つを選び、導入を決めるのもその1つです。
判断とはとても難しいもので、ほぼ確実に間違いは起きます。例えば、「実行速度が遅いが高速な開発には必要であろう」と判断して導入したが、実際運用してみるとやっぱり遅くてやいのやいの言われるとか。入れてみたいからという理由でライブラリを入れる判断をして、ある場所では使われてるけど、ある場所では使われておらずゴチャゴチャになってるとか。似たようなライブラリが3,4個導入されていて、どれが一番使うべきなのか判断出来ないとか。働き始めて5,6年の僕が失敗したな〜と思うだけでも色々あるわけです。
そこで僕が仮にポックリ逝ってしまったとしても、僕の失敗をみなさんが活かせていい感じに開発出来ると僕も生きた意味あると思うので、新たなライブラリを導入するときに考えていることを共有します。
あくまでひさいちが考えてる事なので、書いてる事以外に重要なこともあるでしょうし、より良い方法考え続ける事でバンバン良くしていきましょう。（これだけ抑えておけば絶対破滅しないというわけではない）
ライブラリを導入するからにはライブラリについて考える。
ライブラリのメリットとデメリットは何か？必ず複数個挙げる。 気をつける点として、メリットで「わかりやすくなる」をあげる場合があるが、これはあくまで個人の感想で事実ではない。メリットとデメリットには事実のみ書くべき。
モバイルアプリはインストールする必要があるので、アプリサイズをなるべく小さくしたい気持ちがある。なので、ライブラリのサイズがあまりに大きいものは採用しない。
多少気にする。必要があれば計測する。
自分やチームは今どういう課題を抱えていてを考え、ライブラリはどう解決するのか調べる。
似たライブラリといってもどう解決するのか？の部分は違っていたりするので、違いを理解する。
具体的な例を出すとOrmaはSQLをつくるときにテーブル名を文字列で渡す必要がない。文字列でテーブル名を渡す場合、テーブル名がtypoしていたら実行時にエラーとなるが、Ormaはメソッド名なのでコンパイルエラーになる。
自分の場合、仕様が複雑だと理解すると便利！！って大体なるけど、数日後には忘れてる。またライブラリのコードは結局読むので、読みやすい・シンプルなものを選ぶのが後々楽な事が多い
数年間リリースされてないとかだと、ちょっと不安ですね。
無理そうなら複数人でメンテナンスされてるものを選ぶ
それなりに他社でも事例があると安心ですね
残念なことに導入して終わりではないので、先を見越して考えておく。ここが雑だとライブラリが優れていても途中で失敗したりする。
広げる事について考えている時にメリットやデメリットを話せないと説得力が無なので広がらない。だから、そのあたりは先に考えておく。
Fearless Change アジャイルに効く アイデアを組織に広めるための48のパターンは大げさだけど、活かせることがあるかもしれません。
Fearless Change アジャイルに効く アイデアを組織に広めるための48のパターン
すでにあるプロダクトに新たなライブラリを導入する場合は考えます。 どこから始めて、どこで終わりとするのか見えてないと導入後いつの間にか負債となってしまう…
またこれを決める時にどういう実装になるのかを軽く実装して確認する。 無理なく、全員で進められるというのを大事にしている。
こうして改めて文章にしてみるとライブラリについて考えるだけではなく、チームにどう広げるか等も考えている事に気づいた。そう思うとペパボの評価軸である「先を見通す力」「影響を広げる力」が主に必要で、なんならライブラリを導入のために何か作る必要があるのなら「作り上げる力」が必要になってくるのだなと思いました（Retrofit2導入時には、テスト用のクラスを作ったりしました）
追記：当たり前すぎて忘れてたけど、ライセンスも見てた。
Android Studio 3.0系ではAAPT2がデフォルトでONになっているので、Robolectric 3.3.2ではリソースまわりでエラーが出て動かないようだ。
AAPT2. We are continuing to stabilize AAPT2 which enables incremental resource processing. If your build fails due to resource processing issue, please send us a bug report. To temporarily disable AAPT, set android.enableAapt2=false in your gradle.properties file.
a. Roboelectric is currently not compatible with AAPT2
Android Studio Release Updates: Android Studio 3.0 Canary 5 is now available
AAPT2をfalseにするのも試したけど、テスト用のApplicationクラスを実行してくれなかったので、めんどくさくなって将来的に必要であろうということでバージョンアップした。
追記：テスト用のApplicationクラスを実行してくれなかったというのは僕の勘違いだった！！！！
org.assertj.core.api.Java6Assertions.assertThatの利用をやめるはい
testCompile "org.robolectric:robolectric:3.4.2"
Robolectricのドキュメントであるgetting startedに書かれてある通り、testOptionsを追加する必要がある。
android {
testOptions {
unitTests {
includeAndroidResources = true
}
}
}
ドキュメントはまだ更新されていないけど、Robolectric 3.4のRelease noteを見ると名前が変わっていたので変更した。一応、ドキュメント更新のプルリクを出しておいた。
Some Robolectric sub-projects have been renamed. build.gradle files will need to updated accordingly. [issue #3186]:
robolectric-annotations -> annotations
robolectric-junit -> junit
robolectric-processor -> processor
robolectric-resources -> resources
robolectric-sandbox -> sandbox
robolectric-utils -> utils
shadows-core -> framework
shadows-httpclient -> httpclient
shadows-maps -> maps
shadows-multidex -> multidex
shadows-play-services -> playservices
shadows-support-v4 -> supportv4
Rename projects. by xian · Pull Request #3186 · robolectric/robolectric · GitHub
compileSdkVersion が25未満だとShortcutManagerがないと怒られるのでバージョンを25以上にする必要がある。
org.assertj.core.api.Java6Assertions.assertThatの利用をやめるRobolectric now requires JDK8.
とのことで依存からなくなったようなので、org.assertj.core.api.Assertions.assertThatに変更
まだマージする気はないけど、対応しておくかと思ったのでやってみた。
結構色々と変わっているようだけど、ビルド出来るところまではすぐ出来た。しかしRobolectricまわりでテストが死んでる…（まだ調べてない）追記：Robolectricがエラーになるのを調べたので書いた
diff --git a/gradle/wrapper/gradle-wrapper.properties b/gradle/wrapper/gradle-wr index 4d0f7f7e7..01ed591b3 100644 --- a/gradle/wrapper/gradle-wrapper.properties +++ b/gradle/wrapper/gradle-wrapper.properties @@ -1,6 +1,6 @@ -#Thu Jan 19 11:13:41 JST 2017 +#Tue Sep 05 17:23:15 JST 2017 distributionBase=GRADLE_USER_HOME distributionPath=wrapper/dists zipStoreBase=GRADLE_USER_HOME zipStorePath=wrapper/dists -distributionUrl=https\://services.gradle.org/distributions/gradle-3.3-all.zip +distributionUrl=https\://services.gradle.org/distributions/gradle-4.1-all.zip
古いプラグインは対応していないようなので1.1.3に更新した
https://docs.deploygate.com/v1.1/docs/gradle-plugin
diff --git a/build.gradle b/build.gradle index 156d515ea..ccc0c96f1 100644 --- a/build.gradle +++ b/build.gradle @@ -16,7 +16,7 @@ buildscript { maven { url 'https://jitpack.io' } } dependencies { - classpath 'com.android.tools.build:gradle:2.3.3' + classpath 'com.android.tools.build:gradle:3.0.0-beta4' classpath 'com.deploygate:gradle:1.1.3'
Android Studio 3.0から一部Java8の文法に対応しているようなので削除
icepickとlombokがprovided使ってたので修正
ただLombokがannotationProcessorのみだとエラーになるので、compileOnly も加えた
diff --git a/app/build.gradle b/app/build.gradle index cb74189ff..a62e509c0 100644 --- a/app/build.gradle +++ b/app/build.gradle @@ -260,7 +260,7 @@ dependencies { compile 'frankiesardo:icepick:3.2.0' - provided 'frankiesardo:icepick-processor:3.2.0' + annotationProcessor 'frankiesardo:icepick-processor:3.2.0' @@ -347,7 +347,8 @@ dependencies { transitive = true; } - provided 'org.projectlombok:lombok:1.16.18' + compileOnly "org.projectlombok:lombok:1.16.18" + annotationProcessor "org.projectlombok:lombok:1.16.18" }
