Refatoração

Fala Galera,  desta vez vamos falar sobre o famoso “código que roda” e o código legível. Acho que todos vocês já escutaram a famosa frase “se roda não altere”. Acho que nos ultimos anos(se é que posso falar isso) os desenvolvedores de software vem tendo uma preocupação maior com a qualidade do código que é gerado, mas ainda assim encontramos pedações de código que em 5minutos seriam muito mais faceis de ler.Acho que ficar muito tempo aqui refletindo sobre isso não é produtivo pois já existe um material muito bom na internet. Ainda assim quero registrar o seguinte exemplo criado para representar o sexo de uma pessoa

solução usando campo verdadeiro/false

   1: class Person

   2:    {

   3:        public Boolean sexo { get; set; }

   4:    }

   5:

   6:    class Program

   7:    {

   8:        static void Main(string[] args)

   9:        {

  10:

  11:            Person person = new Person();

  12:            person.sexo = true; //true quando é do sexo masculino

  13:        }

  14:    }

O exemplo acima funciona normalmente, o comentário ajuda a entender o que está sendo feito.. sem ele as coisas ficam dificeis.. este é o codigo que funciona mas não é muito legível

opção 2:

   1: class Person

   2:     {

   3:         public Boolean eHomem { get; set; }

   4:     }

   5:

   6:     class Program

   7:     {

   8:         static void Main(string[] args)

   9:         {

  10:

  11:             Person person = new Person();

  12:             person.eHomem = true; //true quando é do sexo masculino

  13:         }

  14:     }

Ainda usando o campo verdadeiro/false mas com um nome melhor.legibilidade melhorando

opção 3

   1: class Pessoa

   2:     {

   3:         public enum Sexo

   4:         {

   5:             masculino = 1, feminino

   6:         }

   7:         public Sexo sexo { get; set; }

   8:     }

   9:

  10:     class Program

  11:     {

  12:         static void Main(string[] args)

  13:         {

  14:

  15:             Pessoa pessoa = new Pessoa();

  16:             pessoa.sexo = Pessoa.Sexo.masculino;

  17:         }

  18:     }

O código acima continua funcionando e é muito facil de entender. considero este exemplo o melhor dos apresentados

exemplo4(abuso de design)

   1: class ISexo

   2: {

   3:

   4: }

   5: class Masculino : ISexo

   6: {

   7:

   8: }

   9: class Feminino : ISexo

  10: {

  11:

  12: }

  13: class Sexo

  14: {

  15:     //construtor privado

  16:     public static ISexo MASCULINO = new Masculino();

  17:     public static ISexo FEMININO = new Feminino();

  18: }

  19: class Pessoa

  20: {

  21:

  22:     public ISexo sexo { get; set; }

  23: }

  24:

  25: class Program

  26: {

  27:     static void Main(string[] args)

  28:     {

  29:

  30:         Pessoa pessoa = new Pessoa();

  31:         pessoa.sexo = Sexo.MASCULINO;

  32:     }

  33: }

O código acima ainda continua facil pra ler mas é muito exagerado para situação.

Conclusão;
No final de tudo o que importa é usar a abstração aliada ao bom senso. Devemos ser capazes de expressar nosso desejo facilmente sem exageros ou rodeios.

ps: um agradecimento ao guru que vira e mexe me faz refletir sobre como programar melhorHello Folks,we will talk  about the famous “code that runs  and readable code”. I think everybody at least once had heard “if it is working don’t change it”. I think that in the last years(if I’m able to say it) developers had been a doing some improvements when the subject is software quality. Although this improvement is still possible to find pieces of code that could be simplified in five minutes.I thnk that is a waste of time stay trying to explain this problem. I qant to show you an example of code that was used to represent a person field called gender.

solution using a bool field

   1: class Person

   2:    {

   3:        public Boolean sexo { get; set; }

   4:    }

   5:

   6:    class Program

   7:    {

   8:        static void Main(string[] args)

   9:        {

  10:

  11:            Person person = new Person();

  12:            person.sexo = true; //true when is male

  13:        }

  14:    }

subtitle:

sexo means gender.

The example above works as expected, the comments in the code helps to understand what is been done.without this comment the purpose is harder to understand.

example 2

   1: class Person

   2:     {

   3:         public Boolean eHomem { get; set; }

   4:     }

   5:

   6:     class Program

   7:     {

   8:         static void Main(string[] args)

   9:         {

  10:

  11:             Person person = new Person();

  12:             person.eHomem = true; //true when is male

  13:         }

  14:     }

subtitle:

ehomem means isMale

Still using a boolean field, but now this fields contains a better name. so the readability is getting better.

example 3

   1: class Pessoa

   2:     {

   3:         public enum Sexo

   4:         {

   5:             masculino = 1, feminino

   6:         }

   7:         public Sexo sexo { get; set; }

   8:     }

   9:

  10:     class Program

  11:     {

  12:         static void Main(string[] args)

  13:         {

  14:

  15:             Pessoa pessoa = new Pessoa();

  16:             pessoa.sexo = Pessoa.Sexo.masculino;

  17:         }

  18:     }

subtitle:

sexo=gender,pessoa=person,masculino = male,feminino= female

The code above still works and is easier to understand. I think that this example is the easiest one.

example 4(too much design considerations)

   1: class ISexo

   2: {

   3:

   4: }

   5: class Masculino : ISexo

   6: {

   7:

   8: }

   9: class Feminino : ISexo

  10: {

  11:

  12: }

  13: class Sexo

  14: {

  15:     //construtor privado

  16:     public static ISexo MASCULINO = new Masculino();

  17:     public static ISexo FEMININO = new Feminino();

  18: }

  19: class Pessoa

  20: {

  21:

  22:     public ISexo sexo { get; set; }

  23: }

  24:

  25: class Program

  26: {

  27:     static void Main(string[] args)

  28:     {

  29:

  30:         Pessoa pessoa = new Pessoa();

  31:         pessoa.sexo = Sexo.MASCULINO;

  32:     }

  33: }

The code below is still easy to understand, but there are too much code for a easy problem.

After all the most important advice is mix abstraction with pragmatism, so we will be able to show our desires easily.

ps:Thank Sidney for your advices.

Fala galera, Hoje eu estava refatorando uma “Tela” do sistema em que trabalho quando me deparei com o seguinte problema: Eu possuo um método que tem um parâmetro.

private void LoadServiceOrder(Int32 serviceOrderId)

Esta função usa o serviceOrderId para carregar uma Ordem de serviço. Entretanto os desenvolvedores asp.NET devem saber que as páginas .aspx possuem um recurso chamado ViesState, e que nós podemos armazenar algumas informações na mesma. Eu armazeno o serviceOrderId na ViewState pois recupero esta informação de outra página no load da página corrente.

É claro que poderia fazer isso de outras formas evitando o uso da ViewState porem este é o padrão adotado.Bem, o problema é o seguinte: como vocês podem reparar o meu método recebe um valor como parâmetro que ele mesmo pode obter, visto que é posso acessar a ViewState do mesmo. Vale a pena lembrar que estou falando de métodos usados no aspx, não se tratam de métodos que compõem as regras de negócio. Tendo esta dúvida recorri aos compêndios e obtive a seguinte explicação:

“Veja os parâmetros existentes. Você pode solicitar a informação de que precisa a um desses objetos? Caso negativo, faria sentido dar a eles um método para fornecer esta informação? Para que você está usando a informação?esse comportamento deveria estar em outro objeto, o que possui a informação? ”

                        Refatoração aperfeiçoando o projeto de codigo existente – M.Fowler

Analisando meu caso eu o enquadro nesta descrição, pois posso obter o valor de dentro do método. Entretanto quando removi o parâmetro do método achei que a interface não ficou boa.

private void LoadServiceOrder()

Não achei que estava claro qual ordem de serviço está sendo carregada. Ainda escrevendo o post achei que se a assinatura fosse:

private void ShowLoadedServiceOrder()

Meu objetivo ficaria claro, exibo uma ordem de serviço que já foi carregada. O que vocês acham? Já passaram por alguma coisa semelhante? É isso até mais.

Fala galera, um post voltando a discutir o que eu gosto.Hoje vamos falar um pouco sobre boas praticas de desenvolvimento de software.Acho que vocês já escutaram alguns dos mais variados apelidos do copiar & colar.Um dos apelidos  é multiplicador de erros.Bem, Desenvolvedores devem eliminar codigo duplicado certo? então desenvolvedores não devem utilizar o copiar & colar pois ele faz exatamente isso. No livro Refatoração:Aperfeiçoando o projeto de código existente M.Fowler aborda o codigo duplicado como sendo o pior dos odores. Não estou sugerindo que vocês retirem as teclas de copiar e colar. Estou sugerindo muita atenção quando usarem este recurso.Até mais galera..