SBT para Iniciantes: Guia Prático de Programação e Build

<h2>SBT para Iniciantes: Guia Prático de Programação e Build</h2>
<p>Este guia prático tem como objetivo introduzir o SBT (Simple Build Tool) para desenvolvedores iniciantes que desejam construir projetos em Scala e Java. Abordaremos os conceitos fundamentais, a configuração básica, o gerenciamento de dependências e os principais comandos, com exemplos práticos para facilitar o aprendizado.</p>
<h3>O que é SBT?</h3>
<p>SBT é uma ferramenta de automação de build para projetos Scala e Java. Ele é semelhante ao Maven e Gradle, mas é especialmente projetado para Scala e oferece um conjunto rico de funcionalidades para gerenciar dependências, compilar código, executar testes e empacotar aplicações. Uma das principais vantagens do SBT é a sua natureza interativa, permitindo que os desenvolvedores interajam diretamente com o ambiente de build através de um console.</p>
<h3>Instalação do SBT</h3>
<p>Antes de começar, você precisa ter o Java Development Kit (JDK) instalado em sua máquina. Recomenda-se usar a versão 8 ou superior. Para instalar o SBT, siga estas etapas:</p>
<ol>

    <li><strong>Linux/macOS:</strong> Use o SDKMAN! (Software Development Kit Manager). Se você não o tiver instalado, execute o seguinte comando no terminal:

        <pre><code>curl -s "https://get.sdkman.io" | bash</code></pre>

        Após a instalação do SDKMAN!, reinicie o terminal e execute:

        <pre><code>sdk install sbt</code></pre>

    </li>

    <li><strong>Windows:</strong> Você pode baixar o instalador do SBT no site oficial (https://www.scala-sbt.org/download.html) e seguir as instruções de instalação.</li>

</ol>
<p>Após a instalação, verifique se o SBT foi instalado corretamente abrindo o terminal e executando o comando:</p>
<pre><code>sbt sbtVersion</code></pre>
<p>Este comando exibirá a versão do SBT instalada.</p>
<h3>Criando um Projeto SBT</h3>
<p>Para criar um novo projeto SBT, siga estas etapas:</p>
<ol>

    <li>Crie um diretório para o seu projeto. Por exemplo:

        <pre><code>mkdir meu-projeto-sbt

cd meu-projeto-sbt

name := "meu-projeto-sbt"

version := "1.0"


scalaVersion := "2.13.8"

<p><strong>Explicação das configurações:</strong></p>
<ul>

    <li><code>name := "meu-projeto-sbt"</code>: Define o nome do projeto.</li>

    <li><code>version := "1.0"</code>: Define a versão do projeto.</li>

    <li><code>scalaVersion := "2.13.8"</code>: Define a versão do Scala a ser utilizada.</li>

</ul>
<h3>Estrutura de Diretórios do Projeto</h3>
<p>SBT segue uma estrutura de diretórios padrão:</p>
<pre><code>meu-projeto-sbt/

├── build.sbt
├── project/
│ └── plugins.sbt (opcional)
└── src/
├── main/
│ ├── scala/ (ou java/)
│ │ └── … código fonte
│ └── resources/ (arquivos de configuração, etc.)
└── test/
├── scala/ (ou java/)
│ └── … código fonte de teste
└── resources/ (arquivos de teste, etc.)

<p>O diretório <code>src/main/scala</code> (ou <code>src/main/java</code> para projetos Java) contém o código fonte principal do seu projeto. O diretório <code>src/test/scala</code> (ou <code>src/test/java</code>) contém os testes unitários. O diretório <code>project</code> contém arquivos de configuração adicionais, como plugins.</p>
<h3>Adicionando Dependências</h3>
<p>Para adicionar dependências ao seu projeto, você precisa adicionar linhas ao arquivo <code>build.sbt</code>. Por exemplo, para adicionar a biblioteca ScalaTest (para testes unitários), adicione a seguinte linha:</p>
<pre><code>libraryDependencies += "org.scalatest" %% "scalatest" % "3.2.12" % "test"

<p><strong>Explicação:</strong></p>
<ul>

    <li><code>libraryDependencies +=</code>: Indica que estamos adicionando uma dependência.</li>

    <li><code>"org.scalatest" %% "scalatest" % "3.2.12" % "test"</code>: Define a dependência.

        <ul>

            <li><code>"org.scalatest"</code>: O grupo da dependência.</li>

            <li><code>%% "scalatest"</code>: O artefato da dependência (<code>%%</code> significa que o SBT irá adicionar automaticamente a versão do Scala).</li>

            <li><code>"3.2.12"</code>: A versão da dependência.</li>

            <li><code>% "test"</code>: O escopo da dependência (neste caso, apenas para testes).</li>

        </ul>

    </li>

</ul>
<p>Para adicionar outras dependências, basta seguir o mesmo padrão.  Após adicionar as dependências, o SBT irá baixá-las automaticamente na próxima vez que você executar um comando como <code>compile</code> ou <code>test</code>.</p>
<h3>Principais Comandos do SBT</h3>
<p>Aqui estão alguns dos comandos mais utilizados no SBT:</p>
<ul>

    <li><code>compile</code>: Compila o código fonte do projeto.</li>

    <li><code>test</code>: Executa os testes unitários.</li>

    <li><code>run</code>: Executa a aplicação.</li>

    <li><code>package</code>: Empacota a aplicação em um arquivo JAR.</li>

    <li><code>clean</code>: Remove os arquivos gerados durante o build.</li>

    <li><code>console</code>: Abre o console Scala.</li>

    <li><code>reload</code>: Recarrega as configurações do projeto (útil após modificar o arquivo <code>build.sbt</code>).</li>

    <li><code>sbtVersion</code>: Mostra a versão do SBT instalada.</li>

    <li><code>update</code>: Atualiza as dependências do projeto.</li>

</ul>
<p>Para executar um comando, abra o terminal na raiz do diretório do projeto e digite <code>sbt</code> seguido pelo comando. Por exemplo:</p>
<pre><code>sbt compile</code></pre>
<h3>Criando um Código de Exemplo</h3>
<p>Vamos criar um exemplo simples em Scala. Crie o arquivo <code>src/main/scala/Main.scala</code> com o seguinte conteúdo:</p>
<pre><code>object Main {

def main(args: Array[String]): Unit = {
println(“Olá, mundo do SBT!”)
}
}

<p>Agora, execute o comando <code>sbt run</code> no terminal. Você deverá ver a mensagem "Olá, mundo do SBT!" impressa no console.</p>
<h3>Executando Testes</h3>
<p>Vamos criar um teste simples. Primeiro, adicione a dependência do ScalaTest ao seu <code>build.sbt</code> (se já não o fez):</p>

    <pre><code>libraryDependencies += "org.scalatest" %% "scalatest" % "3.2.12" % "test"</code></pre>
<p>Em seguida, crie o arquivo <code>src/test/scala/MainSpec.scala</code> com o seguinte conteúdo:</p>
<pre><code>import org.scalatest.flatspec.AnyFlatSpec

import org.scalatest.matchers.should.Matchers

class MainSpec extends AnyFlatSpec with Matchers {
“The Main object” should “print ‘Olá, mundo do SBT!'” in {
// Redireciona a saída padrão para capturar a mensagem
val stream = new java.io.ByteArrayOutputStream()
Console.withOut(stream) {
Main.main(Array.empty[String])
}
stream.toString should include (“Olá, mundo do SBT!”)
}
}

<p>Agora, execute o comando <code>sbt test</code> no terminal. O SBT irá compilar e executar o teste. Se tudo estiver correto, você verá uma mensagem indicando que o teste foi aprovado.</p>
<h3>Plugins do SBT</h3>
<p>SBT possui um sistema de plugins que permite estender sua funcionalidade. Existem plugins para realizar diversas tarefas, como gerar documentação, verificar a qualidade do código, e publicar a aplicação em repositórios. Para adicionar um plugin, crie o arquivo <code>project/plugins.sbt</code> e adicione a dependência do plugin. Por exemplo, para adicionar o plugin sbt-assembly (para criar um JAR executável), adicione a seguinte linha:</p>
<pre><code>addSbtPlugin("com.eed3si9n" % "sbt-assembly" % "0.15.0")

<p>Após adicionar o plugin, execute o comando <code>reload</code> no console do SBT para que as configurações sejam recarregadas. Em seguida, você poderá usar os comandos fornecidos pelo plugin. Para usar o sbt-assembly, por exemplo, execute o comando <code>assembly</code> para criar um JAR executável.</p>
<h3>Conclusão</h3>
<p>Este guia forneceu uma introdução básica ao SBT. Exploramos a instalação, criação de projetos, gerenciamento de dependências, comandos principais e a utilização de plugins. Com este conhecimento, você está pronto para começar a construir seus próprios projetos em Scala ou Java usando o SBT. Lembre-se de que o SBT é uma ferramenta poderosa e flexível, com muitos recursos avançados. Explore a documentação oficial e experimente diferentes configurações para aproveitar ao máximo o potencial do SBT.</p>
<h3>Perguntas Frequentes (FAQs)</h3>
<p><strong>O que é o arquivo <code>build.sbt</code>?</strong></p>

<p>O arquivo <code>build.sbt</code> é o principal arquivo de configuração do seu projeto SBT. Ele define o nome, versão, dependências e outras configurações importantes do projeto.</p>
<p><strong>Como adicionar uma dependência local (JAR) ao meu projeto SBT?</strong></p>

<p>Você pode adicionar uma dependência local copiando o arquivo JAR para um diretório dentro do seu projeto (por exemplo, <code>lib</code>) e adicionando a seguinte linha ao seu <code>build.sbt</code>:</p>

<pre><code>unmanagedBase := baseDirectory.value / "lib"</code></pre>

<p>Em seguida, execute o comando <code>update</code> no console do SBT.</p>
<p><strong>Como resolver problemas de dependência no SBT?</strong></p>

<p>Problemas de dependência podem ocorrer devido a conflitos de versão ou dependências ausentes. Algumas dicas para resolver esses problemas:</p>

<ul>

    <li>Verifique se as versões das dependências são compatíveis.</li>

    <li>Use o comando <code>update</code> para atualizar as dependências.</li>

    <li>Use o comando <code>dependencyTree</code> (se o plugin `sbt-dependency-tree` estiver instalado) para visualizar a árvore de dependências e identificar conflitos.</li>

    <li>Limpe o cache do SBT (<code>rm -rf ~/.sbt/boot</code>) e tente novamente.</li>

</ul>
<p><strong>Como configurar o SBT para usar um proxy?</strong></p>

<p>Você pode configurar o SBT para usar um proxy definindo as variáveis de ambiente <code>http.proxyHost</code>, <code>http.proxyPort</code>, <code>https.proxyHost</code> e <code>https.proxyPort</code>. Por exemplo:</p>

<pre><code>export http_proxy="http://seu-proxy:porta"

export https_proxy=”http://seu-proxy:porta“

Ou, você pode configurar diretamente no arquivo `~/.sbt/sbt.boot.properties` adicionando as seguintes linhas:

-Dhttp.proxyHost=seu-proxy

-Dhttp.proxyPort=porta

-Dhttps.proxyHost=seu-proxy

-Dhttps.proxyPort=porta

<p><strong>Como posso aprender mais sobre SBT?</strong></p>

<p>A melhor forma de aprender mais sobre SBT é consultar a documentação oficial (https://www.scala-sbt.org/1.x/docs/) e praticar criando projetos. Existem também muitos tutoriais e exemplos disponíveis online.</p>