PL SQL Packages: Guia de Uso

Um package � uma coleç�o de objetos PL/SQL agrupados logicamente sob o nome de pacote. Os packages podem incluir procedures, functions, cursores, declaraç�es, tipos e tamb�m vari�veis. H� in�meras vantagens em coletar objetos em um package. Mais a frente ser�o vistos os benef�cios de sua utilizaç�o.

Os packages geralmente possuem duas partes, uma que se refere a spec e a segunda parte que � o body. A spec � o que chamamos de interface para o package. � nela que declaramos os tipos, vari�veis, constantes, exceç�es, cursores e subprogramas que poder�o ser referenciados a partir de partes externas ao package. Por outro lado, no body definimos as consultas para os cursores e o c�digo para os subprogramas. Em alguns casos pode ser que n�o haja a necessidade de se ter um body.

Em outras palavras, Package PL/SQL � um grupo de funç�es relacionadas, procedimentos, tipos, cursores, dentre outros. Os packages s�o como uma biblioteca, pois uma vez escrito � armazenado no banco de dados Oracle e pode ser usado por muitas aplicaç�es.

De um certo modo, podemos imaginar a spec como sendo uma interface e o body como sendo uma caixa preta. Sabendo disso, podemos entender ent�o que � poss�vel depurar, aprimorar ou substituir bodies de um package sem precisar alterar as especificaç�es do package. Para criar um spec de um package utilizamos a instruç�o SQL CREATE PACKAGE. E para a criaç�o de um bod, utilizamos a instruç�o CREATE PACKAGE BODY.

A spec do package � a interface p�blica de suas aplicaç�es. O p�blico significa que a funç�o armazenada, procedimentos, tipos, s�o acess�veis a partir de outras aplicaç�es. J� o body cont�m o c�digo que implementa as especificaç�es do pacote.

O que podemos ter num package PL/SQL?

Vamos ver a seguir o que podemos definir em um pacote PL/SQL:

Podemos ter m�todos get e set para as vari�veis do package.
Declaraç�o de cursores com o texto da consulta SQL. Reutilizar exatamente o mesmo texto de consulta em v�rios locais se torna mais r�pido do que digitar novamente a mesma consulta, com ligeiras diferenças. Torna-se tamb�m mais f�cil de manter, se precisarmos mudar uma consulta que � usada em muitos lugares.
Declaraç�es para exceç�es. Normalmente, precisamos ser capazes de referenciar estes a partir de diferentes procedures, de modo que podemos lidar com as exceç�es com chamadas de subprogramas.
Declaraç�es para procedures e functions que chamam um ao outro. N�o precisamos nos preocupar com a ordem de compilaç�o das procedures e functions �empacotadas�.
Declaraç�es para procedimentos e funç�es de sobrecarga (overload). Podemos criar v�rias variaç�es de uma procedure ou function usando os mesmos nomes, mas com diferentes conjuntos de par�metros.
Podemos tratar vari�veis num package como sendo vari�veis globais.
Tipos de declaraç�es para coleç�es de tipos PL/SQL. Para passar uma coleç�o, como um par�metro entre stored procedures ou functions, devemos declarar o tipo em um package. Deste modo, tanto a chamada quanto o chamado do subprograma podem ser referenciados.

Quais as vantagens de utilizaç�o de packages PL/SQL?

A utilizaç�o de packages tem uma longa hist�ria no que diz respeito a engenharia de softwares, oferecendo caracter�sticas importantes de f�cil manutenç�o, reutilizaç�o de c�digo, muitas vezes em esforços dentro de uma equipe de desenvolvimento para o desenvolvimento de grandes sistemas. Apresentaremos ent�o alguns dos principais pontos vantajosos na utilizaç�o de packages.

Modularidade - Packages permitem encapsular tipos relacionados logicamente, itens e sub-programas em um m�dulo PL/SQL. Cada package fica f�cil de entender, e as interfaces entre eles tornam-se mais simples, claras e bem definidas. Isso ajuda e muito no desenvolver de aplicativos.
Aplicaç�o simples de design - Ao projetarmos um aplicativo, tudo que precisamos, inicialmente, � a informaç�o de interface nas especificaç�es da embalagem. Desta forma, podemos codificar e compilar uma especificaç�o sem o seu corpo. Em seguida, os subprogramas armazenados que referenciam o pacote podem ser compilados tamb�m. De certa forma, n�o precisamos definir os corpos dos packgaes totalmente at� que seja necess�rio.
Ocultaç�o de informaç�es - Com os packages, podemos especificar quais tipos, itens e sub-programas ser�o p�blicos (vis�veis e acess�veis) ou privados (escondido e inacess�vel). Por exemplo, se um pacote cont�m quatro subprogramas, tr�s poder�o ser p�blicos e um deles privado. O package esconde a implementaç�o de subprogramas privados para que somente o pr�prio package (e n�o a sua aplicaç�o) seja afetado se houver mudanças de implementaç�o. Isso simplifica a manutenç�o e o aprimoramento no desenvolvimento. Al�m disso, ao esconder os detalhes da implementaç�o dos usu�rios, isso remete a proteger a integridade dos packages.
Melhor performance - Quando chamamos um subprograma empacotado pela primeira vez, todo o package � carregado na mem�ria. O que quer dizer que quando se tem a necessidade de reutilizaç�o do package, ele ser� recuperado de maneira mais r�pida e eficiente por estar em mem�ria, n�o havendo a necessidade de busca no disco.

Os Packages param as depend�ncias em cascata e evitam recompilaç�es desnecess�rias. Podemos pensar no seguinte exemplo, se alterarmos o body de uma function que est� num package, o Oracle n�o ir� recompilar outros subprogramas que chamam por esta function. Estes subprogramas s� dependeram dos par�metros e valores de retorno que ser�o declarados na especificaç�o, ent�o eles s� s�o recompilados se houverem mudanças na spec e n�o quando as mudanças s�o no body.

Criando PL/SQL package specification

A especificaç�o do package � necess�rio quando voc� cria um novo package. A especificaç�o do package lista todos os objetos que s�o acess�veis ao p�blico a partir de outras aplicaç�es. A especificaç�o do package tamb�m fornece as informaç�es que os desenvolvedores precisam saber para usar a sua interface. Em suma, a especificaç�o do package � a sua API.

Se a especificaç�o do package n�o cont�m quaisquer funç�es armazenadas, procedures e nenhum c�digo privado sendo necess�rio, ent�o n�o precisamos ter um corpo para o package. Estes packages podem conter apenas as definiç�es dos tipos e declaraç�o de vari�veis. Essas vari�veis s�o conhecidas como dados do pacote. O escopo dos dados � global para as aplicaç�es. Devido a isso � necess�rio encapsular tudo que n�o seja necess�rio como p�blico e fazer uso das funç�es gets e sets para ler e escrever os dados. Ao fazer isso, podemos evitar que os dados dos package sejam alterados de forma err�nea.

De acordo com a Listagem 1, seguem as instruç�es de como criar um package sem o body.

Listagem 1. Criaç�o do package sem o body, apenas com as specs


  CREATE [OR REPLACE] PACKAGE package_name
  [ AUTHID { CURRENT_USER | DEFINER } ]
  { IS | AS } 
     [definitions of public TYPES
     ,declarations of public variables, types, and objects
     ,declarations of exceptions
     ,pragmas
     ,declarations of cursors, procedures, and functions
     ,headers of procedures and functions]
  END [package_name];

A instruç�o CREATE PACKAGE � usada para definir uma nova especificaç�o do pacote. Caso queiramos reconstruir o pacote existente, podemos usar a palavra-chave REPLACE em vez de CREATE. Na especificaç�o do pacote podemos definir novos tipos, declarar vari�veis globais, tipos, objetos, exceç�es, cursores, procedimentos e funç�es.

De acordo com a Listagem 2, temos um exemplo de criaç�o de uma nova especificaç�o de pacote chamado funcion�rio. O pacote de funcion�rio cont�m duas funç�es: get_nomeCompleto() e get_salario() com base na identificaç�o do funcion�rio.

Listagem 2. Criaç�o do package funcion�rio


  CREATE OR REPLACE PACKAGE funcionario AS
    // get nome completo do funcionario
    FUNCTION get_nomeCompleto(n_func_id NUMBER)
      RETURN VARCHAR2;
    // get salario do funcionario
    FUNCTION get_salario(n_func_id NUMBER)
      RETURN NUMBER;
  END funcionario;

Agora criaremos o corpo para o package, de acordo com a Listagem 3.

No body do package PL/SQL fica todo o c�digo que implementa as funç�es armazenadas, procedures e cursores listados na especificaç�o do package.

Listagem 3. Criaç�o do body para o package funcion�rio


  CREATE [OR REPLACE] PACKAGE BODY package_name
     { IS | AS }
   
     [definitions of private TYPEs
     ,declarations of private variables, types, and objects
     ,full definitions of cursors
     ,full definitions of procedures and functions]
  [BEGIN
     sequence_of_statements
   
  [EXCEPTION
     exception_handlers ] ]
   
  END [package_name];

A sintaxe � similar � da criaç�o da spec, exceto pela palavra-chave BODY e o c�digo implementado das especificaç�es do package.

O corpo da package pode conter uma seç�o de inicializaç�o do pacote opcional que aparece no final do corpo de package. As seç�es de inicializaç�o das packages começam com a palavra-chave BEGIN e terminam com a seç�o do EXCEPTION ou a palavra-chave END que finaliza o pacote. A seç�o de inicializaç�o do pacote � executada quando o aplicativo faz refer�ncia ao elemento do package pela primeira vez.

Agora que apresentamos o body do package, faremos um exemplo completo para o package funcion�rio iniciado anteriormente. Apresentamos o nosso exemplo na Listagem 4.

Listagem 4. Criaç�o do exemplo completo de uma package com spec e body


  /*
    Package funcionario body
  */
  CREATE OR REPLACE PACKAGE BODY funcionario AS
    // get funcion�rio nomeCompleto
    FUNCTION get_nomeCompleto(n_func_id NUMBER) RETURN VARCHAR2 IS
        v_nomeCompleto VARCHAR2(46);
    BEGIN
      SELECT primeiro_nome || ',' ||  ultimo_nome
      INTO v_nomeCompleto
      FROM funcionarios
      WHERE empresa_id = n_func_id;
   
      RETURN v_nomeCompleto;
   
    EXCEPTION
    WHEN NO_DATA_FOUND THEN
      RETURN NULL;
    WHEN TOO_MANY_ROWS THEN
      RETURN NULL;
    END; // end get_nomeCompleto
   
     get salario
    FUNCTION get_salario(n_func_id NUMBER) RETURN NUMBER IS
      n_salario NUMBER(8,2);
    BEGIN
      SELECT salario
      INTO n_salario
      FROM funcionarios
      WHERE empresa_id = n_func_id;
   
      RETURN n_salario;
   
      EXCEPTION
        WHEN NO_DATA_FOUND THEN
          RETURN NULL;
        WHEN TOO_MANY_ROWS THEN
          RETURN NULL;
    END;
  END funcionario;

Ainda falta chamarmos nosso package, que ser� visto na Listagem 6. Para fazermos refer�ncia a nosso package utilizamos a seguinte notaç�o mostrada na Listagem 5.

Listagem 5. Chamada do package


  package_name.package_element

Listagem 6. chamando o package funcion�rio


  SET SERVEROUTPUT ON SIZE 1000000;
  DECLARE
    n_salario NUMBER(8,2);
    v_nome   VARCHAR2(46);
    n_func_id NUMBER := &empresa_id;
  BEGIN
   
    v_nome   := funcionario.get_nomeCompleto(n_func_id);
    n_salario := funcionario.get_salario(n_func_id);
   
    IF v_nome  IS NOT NULL AND
      n_salario IS NOT NULL
    THEN
      dbms_output.put_line('Funcion�rio: ' || v_nome);
      dbms_output.put_line('Recebe sal�rio = ' || n_salario);
    END IF;
  END;

Trabalhando com Packages PL/SQL

Neste artigo apresentaremos a utilização de packages PL/SQL, que são áreas de armazenamento de sub-programas, constantes, dentre outros tipos suportados pela linguagem PL/SQL.

O que podemos ter num package PL/SQL?

Quais as vantagens de utilizaç�o de packages PL/SQL?

Criando PL/SQL package specification

Artigos relacionados