使いやすいSDKを目指してやってきたこと

社内勉強会

Transcript

1. ࢖͍΍͍͢SDKΛ໨ࢦͯ͠ ΍͖ͬͯͨ͜ͱ SDKνʔϜ ࠇా
2. About me • ࠇా ༞ੜ(@yuki.kuroda / @darquro) • 2016/5 Supershipೖࣾ • झຯ:ΞϓϦ։ൃ 3ϲ݄Ҏ্ϦδΣΫτଓ͖ (ͱݴ͍͍ͨ)
3. ຊ୊
4. ͷલʹ
5. Ad Generation SDK • Web/App ޲͚ ޿ࠂSDK • όφʔ޿ࠂ/ΠϯλʔεςΟγϟϧ޿ࠂ/ωΠ ςΟϒ޿ࠂ • Web/iOS/Android/Unity/Cocos2d-x * ಈըϦϫʔυ͸ผSDK
6. Ad Generation SDK (App) • 2013/10 v1.0.0 release • 2013/12 Unity plugin release • 2015/2 ΠϯλʔεςΟγϟϧ޿ࠂରԠ • 2015/7 SDK࿈ܞ • 2015/11 Facebook Audience Network࿈ܞ • 2016/2 RTBωΠςΟϒ޿ࠂରԠ
7. Ad Generation SDK (App) ࣄۀͷٸ੒௕ʹ൐͍ɺػೳվྑʹॏ఺Λஔ͍ͯ ͍ͨɻ ΞϓϦ։ൃͷ؀ڥͷมԽ·Ͱ͸௥͑ͯͳ͔ͬͨɻ
8. ΞϓϦ։ൃ؀ڥͷมԽ(2013~) • ৽ݴޠͷొ৔(Swift) • ৽IDEͷొ৔(Android Studio) • ύοέʔδ؅ཧπʔϧͷීٴ
9. ͦ͜Ͱ • ݱࡏͷ։ൃ؀ڥɾݴޠʹԊͬͨSDKʹ͍ͯ͠ ͖͍ͨ
10. ΍ͬͱຊ୊
11. ػೳվྑ΍ෆ۩߹मਖ਼Ҏ֎ʹ SDKͷ࢖͍΍͢͞޲্ͷͨʹ ΍͖ͬͯͨ͜ͱͷ࿩
12. ΞδΣϯμ • CocoaPodsରԠ • Clang ModulesରԠ • Swift OptionalܕରԠ • Android AARରԠ • Maven RepositoryରԠ • ϚχϡΞϧ ϒϥογϡΞοϓ • FAQ ϒϥογϡΞοϓ iOS Android ͦͷଞ
13. CocoaPodsରԠ
14. CocoaPods • iOSϓϩδΣΫτͷύοέʔδ؅ཧπʔϧ • ଞʹ΋Carthage(ΑΓγϯϓϧ)ɺSwift Package Manager(AppleެࣜɺϚϧνϓϥο τϑΥʔϜ)ͳͲ͕͋Δ
15. SDKखಈΠϯετʔϧͷ৔߹ • GitHub͔ΒzipΛμ΢ϯϩʔυ • XcodeʹϥΠϒϥϦͱͯ͠௥Ճ • ґଘframeworkΛϚχϡΞϧΛ֬ೝ͠ͳ͕Β ௥Ճ
16. ొ࿥ํ๏ᶃ podspecͷ࡞੒ Pod::Spec.new do |s| s.name = "AdGeneration" s.version = "2.8.0" s.license = { ɹɹɹɹɹɹɹɹɹɹɹɹ :type => “Copyright", ɹɹɹɹɹɹɹɹɹɹɹɹ :text => "Copyright (c) Supership Inc. All rights reserved." ɹɹɹɹɹɹɹɹɹɹɹɹ} s.platform = :ios, "7.0" s.source = { ɹɹɹɹɹɹɹɹɹɹɹɹ :http => "https://github.com/AdGeneration/ADG-iOS-SDK/releases/ download/2.8.0/ADG.framework.zip" ɹɹɹɹɹɹɹɹɹɹɹɹ} s.vendored_frameworks = "ADG.framework" s.resources = "ADG.framework/Versions/A/Resources/ADG-Resources.bundle" s.frameworks = "SystemConfiguration", "CoreTelephony", “CoreLocation", "AVFoundation", "CoreMedia", "MediaPlayer" s.weak_framework = "AdSupport" end
17. ొ࿥ํ๏ᶄϢʔβʔ࡞੒ $ pod trunk register adg-dev@supership.jp ‘AdGeneration’ ϝʔϧ͕ಧ͍ͯɺΞΫςΟϕʔγϣϯͨ͠Β׬ྃ
18. ొ࿥ํ๏ᶅ push $ pod trunk push [!] Found podspec `AdGeneration.podspec` Updating spec repo `master` warning: inexact rename detection was skipped due to too many files. warning: you may want to set your diff.renameLimit variable to at least 6046 and retry the command. CocoaPods 1.2.1.beta.1 is available. To update use: `sudo gem install cocoapods --pre` [!] This is a test version we'd love you to try. For more information, see https://blog.cocoapods.org and the CHANGELOG for this version at https://github.com/CocoaPods/CocoaPods/releases/tag/1.2.1.beta.1 Validating podspec -> AdGeneration (2.4.3) Updating spec repo `master` -------------------------------------------------------------------------------- Congrats AdGeneration (2.4.3) successfully published April 4th, 15:53 https://cocoapods.org/pods/AdGeneration Tell your friends! ————————————————————————————————————————
19. ࢖͍ํʢΞϓϦଆʣ $ pod init # Uncomment the next line to define a global platform for your project platform :ios, '9.0' target ‘MyApp' do use_frameworks! # Pods for MyApp pod ‘AdGeneration' end 1PEpMF $ pod install
21. Clang ModulesରԠ
22. Clang Modules • Clangͷػೳ • ϔομʔϑΝΠϧΛ·ͱΊΒΕΔ • SwiftͰϥΠϒϥϦΛ࡞Δ৔߹͸ɺࣗಈతʹ ModulesԽ͞ΕΔ
23. ࠓ·ͰSwiftΞϓϦͰ ΞυδΣωSDKΛ࢖͏৔߹ ΞϓϦଆͰ#SJEHF
    IFBEFSϑΝΠϧΛ࡞੒͠ɺඞཁͳϔομʔϑΝΠϧͷهड़͕ඞཁ #import <ADG/ADGManagerViewController.h> #import <ADG/ADGInterstitial.h> #import <ADG/ADGSettings.h> #import <ADG/ADGNativeAd.h>
24. Clang ModuleରԠ framework module ADG { umbrella header "ADG.h" export * module * { export * } } Modules/modul.modulemap
25. Clang ModuleରԠ #import <ADG/ADGManagerViewController.h> #import <ADG/ADGInterstitial.h> #import <ADG/ADGSettings.h> #import <ADG/ADGNativeAd.h> #import <ADG/ADGInformationIconView.h> #import <ADG/ADGMediaView.h> #import <ADG/ADGAdWebView.h> #import <ADG/ADGConstants.h> #import <ADG/ADGData.h> #import <ADG/ADGImage.h> #import <ADG/ADGLink.h> #import <ADG/ADGTitle.h> #import <ADG/ADGNativeInterfaceChild.h> #import <ADG/ADGLogger.h> #import <ADG/ADGVideo.h> Headers/ADG.h
26. Clang ModuleରԠ import ADG class ViewController: UIViewController { } 4XJGUΞϓϦଆͰ#SJEHF
    IFBEFSϑΝΠϧ͸ෆཁʹɻ
27. Clang ModuleରԠ @import ADG; @implementation ViewController @end #import <ADG/ADGManagerViewController.h> #import <ADG/ADGNativeAd.h> @implementation ViewController @end 0CK$ͷΞϓϦͰ΋লུՄೳʹɻ
29. Swift OptionalܕରԠ
30. Swift Optional value • Null Safety • Kotlin, TypeScript, … var str: String? str = "hoge" if let a = str { // Unwrap print(a) // => “hoge” } str = nil let b = str?.characters.count // b == nil
31. Swift Optional value @interface Foo : NSObject @property (nonatomic) NSString *bar; @end let foo = Foo() let bar = foo.bar // foo.bar: String! -> nilͷͱ͖Ϋϥογϡ 0CKD 4XJGU ࠓ·Ͱ͸
32. Swift Optional value @interface Foo : NSObject @property (nonatomic, nullable) NSString *bar; @end let foo = Foo() if let bar = foo.bar { // foo.bar: String? print(bar) // bar: String -> Null Safe } 4XJGU 0CKD nullableΛ͚ͭΔͱ
33. ΞυδΣω ωΠςΟϒ޿ࠂ @interface ADGNativeAd : NSObject @property (nonatomic, strong, readonly) ADGTitle *title; @property (nonatomic, strong, readonly) ADGImage *mainImage; @property (nonatomic, strong, readonly) ADGImage *iconImage; @property (nonatomic, strong, readonly) ADGData *sponsored; @property (nonatomic, strong, readonly) ADGData *desc; @property (nonatomic, strong, readonly) ADGData *ctatext; … @end 0CKD // nullableࢦఆ͕ͳ͍ͱ͖͸͏͔ͬΓͦͷ··ΞΫηε͢ΔͱΫϥογϡͯ͠͠·͏ let url = adgNativeAd.mainImage.url 4XJGU
34. ΞυδΣω ωΠςΟϒ޿ࠂ @interface ADGNativeAd : NSObject @property (nonatomic, strong, readonly, nullable) ADGTitle *title; @property (nonatomic, strong, readonly, nullable) ADGImage *mainImage; @property (nonatomic, strong, readonly, nullable) ADGImage *iconImage; @property (nonatomic, strong, readonly, nullable) ADGData *sponsored; @property (nonatomic, strong, readonly, nullable) ADGData *desc; @property (nonatomic, strong, readonly, nullable) ADGData *ctatext; … @end 0CKD // UnwrapͰ҆શʹΞΫηε if let url = adgNativeAd.mainImage.url { } 4XJGU
36. Android AARରԠ
37. AndroidϥΠϒϥϦ • JARܗࣜ • AARܗࣜ -> javaͷclassesϑΝΠϧ͚ͩ͡Όͳ͘ɺAndroidManifest.xmlͳ Ͳ΋ؚΊΒΕΔ
38. Android AAR • ී௨ʹAndroid StudioͰϥΠϒϥϦϓϩδΣ ΫτΛ࡞੒ͯ͠Ϗϧυ͢Ε͹উखʹग़དྷΔ ./{module}/build/outputs/aar • ΞυδΣω͸Eclipse࣌୅͔ΒͷҠߦͷͨΊjar ΋Ϗϧυͯ͠࡞͍ͬͯͨ
39. Android AAR ͨͩ͠ɺͦͷ··ͩͱɺ • {module}-release.aar • {module}-debug.aar Έ͍ͨͳ໊લʹͳΔͷͰɺόʔδϣϯ൪߸΍ɺ ϦϦʔεϏϧυ࣌͸”release”͸আ֎͍ͨ͠ɻ
40. Android AAR android {
 … libraryVariants.all { variant ->
 variant.outputs.each { output ->
 def libraryFileName = output.outputFile.name
 if (variant.name == android.buildTypes.release.name) {
 libraryFileName = libraryFileName.replace('-release', '')
 }
 libraryFileName = libraryFileName .replace(‘.aar’, "-${defaultConfig.versionName}.aar")
 output.outputFile = new File(output.outputFile.parent, libraryFileName)
 }
 }
 } w lSFMFBTFzͷ࡟আ
    w όʔδϣϯͷ௥Ճ BEHBBS build.gradle
41. Android AAR ./adg/build/outputs/aar ├── adg-2.8.0.aar └── adg-debug-2.8.0.aar
43. Maven RepositoryରԠ
44. SDKखಈΠϯετʔϧͷ৔߹ • GitHub͔ΒaarΛμ΢ϯϩʔυ • Android StudioͰϞδϡʔϧొ࿥ • ΞϓϦͷdependenciesʹ௥Ճ
45. Apache Maven • Java༻ϓϩδΣΫτ؅ཧπʔϧ • Apache Antͷ୅ΘΓͱͯ͠࡞ΒΕͨ
46. AndroidϥΠϒϥϦͷެ։ ֎෦ͷϦϙδτϦ • Bintray jCenter • Maven Central jCenterͩͱֹ݄ར༻ྉ͕݁ߏߴ͍ʢ$150/monthʣ
47. AndroidϥΠϒϥϦͷެ։ ʲAndroidʳ.aarΛGitHub PagesΛ࢖ͬͯެ։͢Δ http://tech.admax.ninja/2014/09/30/how-to-publish-to-github-pages-the- aar-of-customview/ GitHub PagesΛ࢖ͬͯެ։Ͱ͖Δ • ແྉ • ݩʑSDKμ΢ϯϩʔυ༻ʹ࢖ͬͯΔ
48. Maven RepositoryΛϩʔΧϧʹग़ྗ apply plugin: 'maven' … /**
 * Create Maven repository
 *
 * add "repository" directory to project root
 */
 uploadArchives {
 repositories {
 mavenDeployer {
 def repo = new File(rootDir, 'repository')
 repository url: "file://${repo.absolutePath}"
 pom.version = android.defaultConfig.versionName
 pom.groupId = groupId
 pom.artifactId = artifactId
 }
 }
 }
 build.finalizedBy(uploadArchives) build.gradle QMVHJO௥Ճ ϩʔΧϧʹग़ྗ CVJMEλεΫͷޙʹ࣮ߦ
49. Maven RepositoryΛϩʔΧϧʹग़ྗ repository └── com └── socdm └── d └── adgeneration └── adg ├── 2.8.0 │ ├── adg-2.8.0.aar │ ├── adg-2.8.0.aar.md5 │ ├── adg-2.8.0.aar.sha1 │ ├── adg-2.8.0.pom │ ├── adg-2.8.0.pom.md5 │ └── adg-2.8.0.pom.sha1 ├── maven-metadata.xml ├── maven-metadata.xml.md5 └── maven-metadata.xml.sha1
50. GitHub Pagesʹpush
51. ΞϓϦͰSDKͷΠϯετʔϧ allprojects {
 repositories {
 jcenter()
 maven { url 'https://adgeneration.github.io/ADG-Android-SDK/repository' }
 }
 } dependencies {
 compile fileTree(dir: 'libs', include: ['*.jar'])
 androidTestCompile('com.android.support.test.espresso:espresso-core:2.2.2', {
 exclude group: 'com.android.support', module: 'support-annotations'
 })
 compile 'com.android.support:appcompat-v7:25.3.1'
 compile 'com.android.support.constraint:constraint-layout:1.0.2'
 testCompile 'junit:junit:4.12'
 compile 'com.google.android.gms:play-services-ads:11.0.2'
 compile 'com.socdm.d.adgeneration:adg:+'
 } τοϓϨϕϧCVJMEHSBEMF ΞϓϦϨϕϧCVJMEHSBEMF
53. ϚχϡΞϧϒϥογϡΞοϓ
54. ϚχϡΞϧʹGitHub wiki
55. 2016/2 ࣌఺ͷτοϓ
56. 2016/2 ࣌఺ͷτοϓ •ϓϥοτϑΥʔϜɺ޿ࠂϑΥʔϚο τɺΞυωοτϫʔΫ͕ࠞࡏ •ུশ •ಋೖॱ൪͕Θ͔Βͳ͍
57. ݱࡏͷτοϓ
58. ݱࡏͷτοϓ ޿ࠂϑΥʔϚοτ͝ͱʹେ߲໨Λ෼ྨ αΠυϝχϡʔΛ௥Ճ ϓϥοτϑΥʔϜ͝ͱʹϚχϡΞϧΛ෼཭ શͯͷϚχϡΞϧʹτοϓ͔Βߦ͚Δ Α͏ಋઢΛෑ͍ͨ
59. ݱࡏͷτοϓ 4%,࿈ܞʹ͍ͭͯͷৄ͍͠આ໌ͱɺ֤Ξυωο τϫʔΫʹ͍ͭͯͷઆ໌΋௥Ճ
60. ֤छϚχϡΞϧͷมߋ *%&ͷૢ࡞ͷ෦෼͸ը૾Ͱઆ໌ چ ৽
61. ֤छϚχϡΞϧͷมߋ ίʔυϒϩοΫ͸γϯλοΫεϋΠϥΠτ Λ͚ͭΔ چ ৽
62. ֤छϚχϡΞϧͷมߋ ϦϑΝϨϯεΛ࡞੒
63. FAQϒϥογϡΞοϓ
64. FAQ
65. FAQ • SDK࣮૷ϚχϡΞϧͱ৘ใ͕ॏෳ • ৘ใ͕ߋ৽ͯ͠ͳ͍ʢϝϯς͸Ӧۀ͕୲౰ʣ • ࣾ֨໰୊
66. FAQ • Ӧۀ͕ϝϯς୲౰ͳͷͰɺ΢έૂ͍͸࡟আ͠ ͯ΋Β͍ɺ੔ཧΛ͓ئ͍ͨ͠ɻ • Ͳ͕͜SDKϚχϡΞϧͱॏෳ͢Δ͔Λ఻͑ɺ ඞཁͳ΋ͷΛߜͬͯ΋Βͬͨɻ
67. ·ͱΊ
68. ·ͱΊ • SDK͸ݱࡏͷ։ൃ؀ڥʹϚονͨ͠ͱ͜Ζ· Ͱ͜Εͨͱࢥ͏ɻ • ϚχϡΞϧ͸ݟ΍͘͢ɺ୳͠΍͘͢ͳͬͨͱ ࢥ͏ɻ
69. ͓ΘΓ