YukiReflection/docs/assets/quick-start.html.a839f1ea.js

import{_ as o,r as i,o as t,c,b as s,d as a,a as l,e}from"./app.2add9aa5.js";const p={},r=l('<h1 id="quick-start" tabindex="-1"><a class="header-anchor" href="#quick-start" aria-hidden="true">#</a> Quick Start</h1><blockquote><p>Integrate <code>YukiReflection</code> into your project.</p></blockquote><h2 id="environment-requirements" tabindex="-1"><a class="header-anchor" href="#environment-requirements" aria-hidden="true">#</a> Environment Requirements</h2><ul><li><p>Windows 7 and above / macOS 10.14 and above / Linux distributions (Arch/Debian)</p></li><li><p>Android Studio 2021.1 and above</p></li><li><p>IntelliJ IDEA 2021.1 and above</p></li><li><p>Kotlin 1.7.0 and above</p></li><li><p>Android Gradle Plugin 7.0 and above</p></li><li><p>Gradle 7.0 and above</p></li><li><p>Java 11 and above</p></li></ul><h2 id="project-requirements" tabindex="-1"><a class="header-anchor" href="#project-requirements" aria-hidden="true">#</a> Project Requirements</h2><p>The project needs to be created using <code>Android Studio</code> or <code>IntelliJ IDEA</code> and the type is an Java or Android project and the <code>Kotlin</code> environment dependency has been integrated.</p><h2 id="integration-dependencies" tabindex="-1"><a class="header-anchor" href="#integration-dependencies" aria-hidden="true">#</a> Integration Dependencies</h2>',7),d=e("We recommend using Kotlin DSL as the Gradle build script language and "),u={href:"https://github.com/HighCapable/SweetDependency",target:"_blank",rel:"noopener noreferrer"},v=e("SweetDependency"),y=e(" to manage dependencies."),h=l(`<h4 id="sweetdependency-method" tabindex="-1"><a class="header-anchor" href="#sweetdependency-method" aria-hidden="true">#</a> SweetDependency Method</h4><p>Add the repositories and dependencies in your project&#39;s <code>SweetDependency</code> configuration file.</p><blockquote><p>The following example</p></blockquote><div class="language-yaml ext-yml line-numbers-mode"><pre class="shiki" style="background-color:#22272e;"><code><span class="line"><span style="color:#8DDB8C;">repositories</span><span style="color:#ADBAC7;">:</span></span>
<span class="line"><span style="color:#ADBAC7;">  </span><span style="color:#768390;"># MavenCentral has a 2-hour cache,</span></span>
<span class="line"><span style="color:#ADBAC7;">  </span><span style="color:#768390;"># if the latest version cannot be integrated, please add this</span></span>
<span class="line"><span style="color:#ADBAC7;">  </span><span style="color:#8DDB8C;">sonatype-oss-releases</span><span style="color:#ADBAC7;">:</span></span>
<span class="line"></span>
<span class="line"><span style="color:#8DDB8C;">libraries</span><span style="color:#ADBAC7;">:</span></span>
<span class="line"><span style="color:#ADBAC7;">  </span><span style="color:#8DDB8C;">com.highcapable.yukireflection</span><span style="color:#ADBAC7;">:</span></span>
<span class="line"><span style="color:#ADBAC7;">    </span><span style="color:#8DDB8C;">api</span><span style="color:#ADBAC7;">:</span></span>
<span class="line"><span style="color:#ADBAC7;">      </span><span style="color:#8DDB8C;">version</span><span style="color:#ADBAC7;">: </span><span style="color:#96D0FF;">+</span></span>
<span class="line"><span style="color:#ADBAC7;">  </span><span style="color:#6CB6FF;">...</span></span>
<span class="line"></span></code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p>After adding it, run Gradle Sync and all dependencies will be autowired.</p><p>Next, deploy dependencies in your project <code>build.gradle.kts</code>.</p><blockquote><p>The following example</p></blockquote><div class="language-kotlin ext-kt line-numbers-mode"><pre class="shiki" style="background-color:#22272e;"><code><span class="line"><span style="color:#ADBAC7;">dependencies {</span></span>
<span class="line"><span style="color:#ADBAC7;">    implementation(com.highcapable.yukireflection.api)</span></span>
<span class="line"><span style="color:#ADBAC7;">    </span><span style="color:#768390;">// ...</span></span>
<span class="line"><span style="color:#ADBAC7;">}</span></span>
<span class="line"></span></code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><h4 id="traditional-method-not-recommended" tabindex="-1"><a class="header-anchor" href="#traditional-method-not-recommended" aria-hidden="true">#</a> Traditional Method (Not Recommended)</h4><p>Add repositories in your project <code>build.gradle.kts</code> or <code>build.gradle</code>.</p><blockquote><p>Kotlin DSL</p></blockquote><div class="language-kotlin ext-kt line-numbers-mode"><pre class="shiki" style="background-color:#22272e;"><code><span class="line"><span style="color:#ADBAC7;">repositories {</span></span>
<span class="line"><span style="color:#ADBAC7;">    google()</span></span>
<span class="line"><span style="color:#ADBAC7;">    mavenCentral()</span></span>
<span class="line"><span style="color:#ADBAC7;">    </span><span style="color:#768390;">// MavenCentral has a 2-hour cache, if the latest version cannot be integrated, please add this URL</span></span>
<span class="line"><span style="color:#ADBAC7;">    maven { url(</span><span style="color:#96D0FF;">&quot;https://s01.oss.sonatype.org/content/repositories/releases/&quot;</span><span style="color:#ADBAC7;">) }</span></span>
<span class="line"><span style="color:#ADBAC7;">}</span></span>
<span class="line"></span></code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><blockquote><p>Groovy DSL</p></blockquote><div class="language-groovy ext-groovy line-numbers-mode"><pre class="shiki" style="background-color:#22272e;"><code><span class="line"><span style="color:#ADBAC7;">repositories {</span></span>
<span class="line"><span style="color:#ADBAC7;">    google()</span></span>
<span class="line"><span style="color:#ADBAC7;">    mavenCentral()</span></span>
<span class="line"><span style="color:#ADBAC7;">    </span><span style="color:#768390;">// MavenCentral has a 2-hour cache, if the latest version cannot be integrated, please add this URL</span></span>
<span class="line"><span style="color:#ADBAC7;">    maven { url </span><span style="color:#96D0FF;">&#39;https://s01.oss.sonatype.org/content/repositories/releases/&#39;</span><span style="color:#ADBAC7;"> }</span></span>
<span class="line"><span style="color:#ADBAC7;">}</span></span>
<span class="line"></span></code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p>Add dependencies in your project <code>build.gradle.kts</code> or <code>build.gradle</code>.</p><blockquote><p>Kotlin DSL</p></blockquote><div class="language-kotlin ext-kt line-numbers-mode"><pre class="shiki" style="background-color:#22272e;"><code><span class="line"><span style="color:#ADBAC7;">dependencies {</span></span>
<span class="line"><span style="color:#ADBAC7;">    implementation(</span><span style="color:#96D0FF;">&quot;com.highcapable.yukireflection:api:&lt;yuki-version&gt;&quot;</span><span style="color:#ADBAC7;">)</span></span>
<span class="line"><span style="color:#ADBAC7;">    </span><span style="color:#768390;">// ...</span></span>
<span class="line"><span style="color:#ADBAC7;">}</span></span>
<span class="line"></span></code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><blockquote><p>Groovy DSL</p></blockquote><div class="language-groovy ext-groovy line-numbers-mode"><pre class="shiki" style="background-color:#22272e;"><code><span class="line"><span style="color:#ADBAC7;">dependencies {</span></span>
<span class="line"><span style="color:#ADBAC7;">    implementation </span><span style="color:#96D0FF;">&#39;com.highcapable.yukireflection:api:&lt;yuki-version&gt;&#39;</span></span>
<span class="line"><span style="color:#ADBAC7;">    </span><span style="color:#768390;">// ...</span></span>
<span class="line"><span style="color:#ADBAC7;">}</span></span>
<span class="line"></span></code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><p>Please change <strong>&lt;yuki-version&gt;</strong> to the latest version <a href="../about/changelog">here</a>.</p>`,20),b={class:"custom-container danger"},A=s("p",{class:"custom-container-title"},"Pay Attention",-1),m=e("If your project is currently using the 1.x.x version of "),D={href:"https://github.com/fankes/YukiHookAPI",target:"_blank",rel:"noopener noreferrer"},g=e("YukiHookAPI"),k=e(", please do not integrate "),C=s("strong",null,"YukiReflection",-1),B=e(" repeatedly, because "),_=s("strong",null,"YukiHookAPI",-1),f=e(" already includes it functions and there are changes to related functions."),q=s("p",null,"Repeated integration will cause functional conflicts and cause exceptions.",-1),x=e("In this case, you should go to the "),F={href:"https://fankes.github.io/YukiHookAPI/zh-cn/",target:"_blank",rel:"noopener noreferrer"},S=e("Documentation"),I=e(" of "),j=s("strong",null,"YukiHookAPI",-1),w=e(" view the corresponding usage tutorial."),R=s("p",null,[s("strong",null,"YukiHookAPI"),e(" will be completely separated from "),s("strong",null,"YukiReflection"),e(" in version 2.x.x, by which time you can use it with "),s("strong",null,"YukiHookAPI"),e(" at the same time.")],-1),V=l(`<h4 id="configure-java-version" tabindex="-1"><a class="header-anchor" href="#configure-java-version" aria-hidden="true">#</a> Configure Java Version</h4><p>Modify the Java version of Kotlin in your project <code>build.gradle.kts</code> or <code>build.gradle</code> to 11 or above.</p><blockquote><p>Kotlin DSL</p></blockquote><div class="language-kotlin ext-kt line-numbers-mode"><pre class="shiki" style="background-color:#22272e;"><code><span class="line"><span style="color:#ADBAC7;">android {</span></span>
<span class="line"><span style="color:#ADBAC7;">    compileOptions {</span></span>
<span class="line"><span style="color:#ADBAC7;">        sourceCompatibility </span><span style="color:#F47067;">=</span><span style="color:#ADBAC7;"> </span><span style="color:#F69D50;">JavaVersion</span><span style="color:#ADBAC7;">.</span><span style="color:#F69D50;">VERSION_11</span></span>
<span class="line"><span style="color:#ADBAC7;">        targetCompatibility </span><span style="color:#F47067;">=</span><span style="color:#ADBAC7;"> </span><span style="color:#F69D50;">JavaVersion</span><span style="color:#ADBAC7;">.</span><span style="color:#F69D50;">VERSION_11</span></span>
<span class="line"><span style="color:#ADBAC7;">    }</span></span>
<span class="line"><span style="color:#ADBAC7;">    kotlinOptions {</span></span>
<span class="line"><span style="color:#ADBAC7;">        jvmTarget </span><span style="color:#F47067;">=</span><span style="color:#ADBAC7;"> </span><span style="color:#96D0FF;">&quot;11&quot;</span></span>
<span class="line"><span style="color:#ADBAC7;">    }</span></span>
<span class="line"><span style="color:#ADBAC7;">}</span></span>
<span class="line"></span></code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div><blockquote><p>Groovy DSL</p></blockquote><div class="language-groovy ext-groovy line-numbers-mode"><pre class="shiki" style="background-color:#22272e;"><code><span class="line"><span style="color:#ADBAC7;">android {</span></span>
<span class="line"><span style="color:#ADBAC7;">    compileOptions {</span></span>
<span class="line"><span style="color:#ADBAC7;">        sourceCompatibility </span><span style="color:#F47067;">JavaVersion.</span><span style="color:#6CB6FF;">VERSION_11</span></span>
<span class="line"><span style="color:#ADBAC7;">        targetCompatibility </span><span style="color:#F47067;">JavaVersion.</span><span style="color:#6CB6FF;">VERSION_11</span></span>
<span class="line"><span style="color:#ADBAC7;">    }</span></span>
<span class="line"><span style="color:#ADBAC7;">    kotlinOptions {</span></span>
<span class="line"><span style="color:#ADBAC7;">        jvmTarget </span><span style="color:#F47067;">=</span><span style="color:#ADBAC7;"> </span><span style="color:#96D0FF;">&#39;11&#39;</span></span>
<span class="line"><span style="color:#ADBAC7;">    }</span></span>
<span class="line"><span style="color:#ADBAC7;">}</span></span>
<span class="line"></span></code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div>`,6);function L(P,E){const n=i("ExternalLinkIcon");return t(),c("div",null,[r,s("p",null,[d,s("a",u,[v,a(n)]),y]),h,s("div",b,[A,s("p",null,[m,s("a",D,[g,a(n)]),k,C,B,_,f]),q,s("p",null,[x,s("a",F,[S,a(n)]),I,j,w]),R]),V])}const N=o(p,[["render",L],["__file","quick-start.html.vue"]]);export{N as default};